Application Documentation

Application documentation is a separate knowledge base area that belongs to a developer application. Developers add instructions and related materials, prepare translations, arrange the public menu, and obtain a help link for users.

Workflow

1. Open the application and go to Documentation.
2. Add materials: folders, Markdown pages, documents, images, tables, or a ZIP archive.
3. Prepare language versions of Markdown pages in Russian, English, or both languages.
4. Arrange folders and pages in the order in which they should appear in the side menu.
5. Configure the public address and verify the documentation as a user sees it.
6. When needed, use documentation search on the site, in agents, and in MCP clients.

Choose a task

• Materials and Structure — adding files and ZIP archives, image recognition, folders, and page reordering.
• Languages and Translations — Russian and English versions of one page, saving, and removing a translation.
• Publication — slug, public link, availability, appearance, and supported formats.
• Search — which applications enter general search and how to use search_documentation.

Storage and permissions

Documentation uses the same tested interface and file processing as a project knowledge base, but materials remain in the application area. They are not copied into installation projects, Ready-made solution versions, or application releases.

The application owner, administrator, and developer can change documentation; an observer can view it. A member can also receive the separate Manage documentation permission. When an application is deleted, its documentation becomes unavailable, while its folders, files, tables, and search index documents remain in internal storage.