All changes in feature/doc_improvements branch by atp-epam · Pull Request #555 · epam/ai-dial

atp-epam · 2026-06-24T13:50:00Z

this is for @YuriyIvon

check BRANCH_GUIDE.md first!

Co-authored-by: Copilot <copilot@github.com>

YuriyIvon · 2026-07-02T07:32:11Z

+
+## What you'll build
+
+A local DIAL stack — DIAL Core, DIAL Chat, Redis, and chat themes — running the [Echo application](https://github.com/epam/ai-dial/tree/main/dial-docker-compose/application/echo), which repeats back whatever you type. This is the canonical "hello world" for the platform.


I would consider using the full Docker Compose instead. Let's see how we can re-shape quick starts based on a Docker Compose that includes Keycloak and Admin

YuriyIvon · 2026-07-02T07:32:32Z

+
+## Step 1: Get the Docker Compose files
+
+Download the [`dial-docker-compose/application`](https://github.com/epam/ai-dial/tree/main/dial-docker-compose/application/) folder from the DIAL repository.


I would consider using the full Docker Compose instead. Let's see how we can re-shape quick starts based on a Docker Compose that includes Keycloak and Admin

YuriyIvon · 2026-07-02T07:33:58Z

+
+## Prerequisites
+
+- Access to a running DIAL deployment that includes [DIAL Admin](../5.administering-dial/0.index.md). If you do not have one, follow the [DevOps quick start](devops-quick-start) first, or use a deployment provided by your platform team.


The DevOps Quick Start doesn’t include DIAL Admin. In my opinion, we need to change the focus of Quick Starts from “quick and dirty” docker compose files “developer only” to the minimal Docker Compose with Keycloak and Admin

YuriyIvon · 2026-07-02T07:34:25Z

+
+DIAL is deliberately modular. Only one component is mandatory.
+
+```text


I would make a visual diagram

YuriyIvon · 2026-07-02T07:35:28Z

+owner: "@dial-docs-team"
+---
+
+# DIAL vs app builders


I would explicitly highlight QuickApps limitations as a no code tool: while canvas-based platforms allow building deterministic flows in addition to AI-based logic, QuickApps are fully agentic - you only have a model, a system prompt, a set of tools and a knowledge base.

YuriyIvon · 2026-07-02T07:35:59Z

+|---|---|---|
+| Compose chains / agents / RAG in code | Yes | Via apps that use a framework |
+| Deployed runtime / app server | No | Yes |
+| Unified API across providers | No | Yes |


Frameworks provide abstractions where you can use the same code regardless of the underlying model, so most likely “No” for “Unified API across providers” is not completely fair for frameworks.

YuriyIvon · 2026-07-02T07:36:33Z

+
+- **Vendor- and cloud-agnostic.** DIAL puts every provider behind one Unified API and runs on any cloud or on-prem. Studios are anchored to their own cloud and model family — Azure with OpenAI and partners, Google with Gemini.
+- **Open-source and self-hostable.** DIAL is licensed under Apache 2.0 and runs in your own environment. Studios are proprietary managed services.
+- **Portability and lock-in.** Building on DIAL keeps applications portable across providers and clouds. Building in a studio ties applications to that vendor.


"Vendor- and cloud-agnostic” and “Portability and lock-in” look the same

YuriyIvon · 2026-07-02T07:37:31Z

+|---|---|---|
+| Build and run AI applications | Yes | Yes |
+| Agent runtime and governance | Yes (varies) | Yes |
+| Reach models across many vendors | No (vendor's own) | Yes |


Sometimes there is some flexibility like Google Vertex AI giving access to Claude, though it is limited. Thus, “No (vendor's own)” looks not completely fair in this case.

YuriyIvon · 2026-07-02T07:38:34Z

+| Dependency | Purpose | Supported options |
+|---|---|---|
+| Blob storage | Persists conversations, prompts, applications, and user files | AWS S3, Google Cloud Storage, Azure Blob Storage, or a local file system (self-hosted) |
+| Redis | In-memory cache with write-back (write-behind) caching | Standalone or cluster |


Perhaps it makes sense to note that any compatible PaaS offering for Redis (e.g. Azure Cache for Redis) can be used either

YuriyIvon · 2026-07-02T07:39:31Z

+- **Rate and cost limits** — flexible usage and cost limits for JWTs and API keys. See [roles and rate limits](../../4.operating-dial/5.auth-and-access-control/3.roles-and-rate-limits.md).
+- **Load balancer** — request distribution across model deployments, with provisioned-throughput support, to prevent bottlenecks and optimize cost.
+- **Observability** — OpenTelemetry-based insight into performance and health.
+- **Evaluation toolkit** — measurement of retrieval and generation quality for RAG-like applications. See [evaluations](../../3.building-with-dial/4.evaluations/0.index.md).


Need to double-check if evaluation toolkit is about RAG applications only. The whole section about evaluation may need to be updated based on the most recent developments.

YuriyIvon · 2026-07-02T07:39:53Z

+- **Attachments** — applications can accept and produce file attachments.
+- **Stages** — render the intermediate steps an agent took to produce a response.
+- **Interactive controls** — buttons, dropdowns, checkboxes, and other controls in generated responses for richer interaction.
+- **Custom renderers** — define custom visualizers for conversations using any visualization library.


Are custom renderers relevant to the Unified API?

YuriyIvon · 2026-07-02T07:40:43Z

+
+## Token rate limiting
+
+Token rate limiting caps the volume of tokens a subject may process within a time window. DIAL counts both input and output tokens and enforces limits across minute, daily, weekly, and monthly intervals. When a subject reaches a limit, further requests are rejected until the window resets.


We need to explicitly explain the logic, that the consumption for both limits is calculated based on a rolling window, not on a calendar window. And also highlight that the consumption is calculated for each user separately. There are no budgets tied to other entities yet.

YuriyIvon · 2026-07-02T07:41:53Z

+
+### Application
+
+A first-class extension in DIAL that exposes chat completion or embedding endpoints via the [DIAL SDK](#dial-sdk) and conforms to the [Unified API](#unified-api). Applications can be invoked directly by users or composed as building blocks in multi-agent workflows.


Custom applications can expose custom APIs in addition to or instead of the standard Unified API endpoints. However, I am not sure if we need to mention it here.

YuriyIvon · 2026-07-02T07:42:34Z

+
+The move to open source and then to a public SaaS offering also signals the intended audience. DIAL is built to be deployed and governed by an enterprise, not only consumed as a hosted service — which is why so much of the platform is about access control, deployment, and operations rather than the model interaction alone.
+
+The DIAL roadmap is not publicly available. To learn more about the platform's history and direction, see [About Us](https://dialx.ai/about-us).


DIAL roadmap is in fact publicly available: https://dialx.ai/roadmap

YuriyIvon · 2026-07-02T07:43:31Z

+
+## Q
+
+### Quick App


Let's check with the team if we need to keep both QuickApps and QuickApps 2.0 in the documentation

atp-epam and others added 30 commits April 27, 2026 15:08

WIP: Establish Claude Code usage, step 1

df13f53

add glossary

0856361

docs-auditor skill

620fb7c

initial claude settings

d88557e

improved CLAUDE.md

f7861de

doc frontmatter check

383d997

Co-authored-by: Copilot <copilot@github.com>

updated git ignore

f0e113c

added Skills reference page

9919b8f

new permissions

f4f9d3a

Co-authored-by: Copilot <copilot@github.com>

added docs-researcher skill

f92fc77

updated docs-auditor skill

599c2da

updated docs-page-writer skill

0f5c8be

fix tool use and temp folder for doc-researcher skill

20a27df

remove incorrect temp folder permission

9dce49f

forbid git commit and push

1d25f44

new rule for handling doc improvements

eb760b6

new config docs

245be43

improved config docs

84ebf97

better organized config section descriptions

a3fe080

externalize repo list to make CLAUDE.md more concise

36c95b3

fix naming

46816db

add graphify and python specific exceptions

26cc2bf

Co-authored-by: Copilot <copilot@github.com>

minor improvements for settings.json docs

af4fe5a

minor improvements for config.json docs

e1adb10

better structuring of docker compose related docs

0b6a831

dial apps overview and custom apps details

ea18754

Merge branch 'main' into feature/doc_improvements

3a5ba6f

quick apps, WIP

5e16d82

cleanup quick apps

2f5f537

quick app tutorial fixes

681ec66

atp-epam added 6 commits June 5, 2026 14:27

chore: housekeeping step 1

dda27fb

fix landing page for new content

19a6537

configurable doc/menu display

3dfb14c

check outdated refernces

e4133a4

Merge branch 'main' into feature/doc_improvements

32fdf1c

branch guide

f699b00

atp-epam requested a review from YuriyIvon June 24, 2026 13:50

changed deploy branch

e674230

atp-epam temporarily deployed to development June 26, 2026 12:28 — with GitHub Actions Inactive

match file and menu structure

73dbcd8

atp-epam temporarily deployed to development June 30, 2026 07:17 — with GitHub Actions Inactive

updated CLAUDE.md to ensure structural integrity

3a27376

atp-epam temporarily deployed to development June 30, 2026 07:33 — with GitHub Actions Inactive

add agentic tools to integration docs

312cb2e

atp-epam deployed to development July 1, 2026 09:41 — with GitHub Actions Active

YuriyIvon reviewed Jul 2, 2026

View reviewed changes


		## What you'll build

		A local DIAL stack — DIAL Core, DIAL Chat, Redis, and chat themes — running the [Echo application](https://github.com/epam/ai-dial/tree/main/dial-docker-compose/application/echo), which repeats back whatever you type. This is the canonical "hello world" for the platform.


		## Step 1: Get the Docker Compose files

		Download the [`dial-docker-compose/application`](https://github.com/epam/ai-dial/tree/main/dial-docker-compose/application/) folder from the DIAL repository.


		## Prerequisites

		- Access to a running DIAL deployment that includes [DIAL Admin](../5.administering-dial/0.index.md). If you do not have one, follow the [DevOps quick start](devops-quick-start) first, or use a deployment provided by your platform team.


		DIAL is deliberately modular. Only one component is mandatory.

		```text


		## Token rate limiting

		Token rate limiting caps the volume of tokens a subject may process within a time window. DIAL counts both input and output tokens and enforces limits across minute, daily, weekly, and monthly intervals. When a subject reaches a limit, further requests are rejected until the window resets.


		### Application

		A first-class extension in DIAL that exposes chat completion or embedding endpoints via the [DIAL SDK](#dial-sdk) and conforms to the [Unified API](#unified-api). Applications can be invoked directly by users or composed as building blocks in multi-agent workflows.


		The move to open source and then to a public SaaS offering also signals the intended audience. DIAL is built to be deployed and governed by an enterprise, not only consumed as a hosted service — which is why so much of the platform is about access control, deployment, and operations rather than the model interaction alone.

		The DIAL roadmap is not publicly available. To learn more about the platform's history and direction, see [About Us](https://dialx.ai/about-us).

Uh oh!

Conversation

atp-epam commented Jun 24, 2026

this is for @YuriyIvon

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants