Publishing Application Documentation
Public address
Before publication, documentation opens through the exact application ID. In the slug field, you can prepare a short unique name containing lowercase Latin letters, digits, and hyphens, and then save it.
After publication, the slug becomes the primary address. Previous slugs redirect to the new one, and the application ID address continues to work. The open documentation button appears after at least one Markdown page is added and remains available regardless of application status.
What the user sees
Public documentation shows the application name and icon, the folder and Markdown page tree, the current page content, a language switch, and search. The avatar from general application settings is used in the header and as the favicon; a standard icon appears when no avatar is set.
Opening the link prefers the cabinet or site language and falls back to an available translation. Switching languages keeps the current page open when it has the corresponding version.
Availability and search
| Application state | Direct ID link | Direct slug link | Application list and general search |
|---|---|---|---|
| Private, pending review, or rejected | Works | Unavailable until publication | Not shown |
| Published but hidden from the catalog | Works | Works | Not shown |
| Published and visible in the catalog | Works | Works | Shown |
Documentation buttons in the catalog and installed application management open the current interface language and fall back to another translation. The exact application ID can also be passed to MCP search regardless of status; see Search for details.
Public pages and other formats
Only a Markdown page receives a separate public URL. PDF, DOCX, TXT, images, and tables may participate in search and help assistants but do not receive their own side-menu page.
User Markdown is rendered safely: raw HTML, scripts, iframes, event handlers, and dangerous URLs do not execute. Related images and safe internal links continue to work.
Updates and deletion
Once documentation is accessible, changes appear immediately and do not require separate review. Application status and visibility are the only barrier to appearing in the general catalog and search.
Documentation is not included in releases or copied into installation projects. Deleting an application removes its materials and search index documents.