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.

Storage and permissions

Materials belong to the application: they are not copied into installation projects, Ready-made solution versions, or application releases. Instructions for uploading and processing files are also available under Knowledge base.

The application owner, administrator, and developer can change documentation; an observer can view it. Access is determined by the application member role. After an application is deleted, its documentation is no longer available through public links or search.