Text Pages
Besides generated documentation, a service can have text pages: Markdown documents written by hand, such as guides, conventions and notes, with pictures. This page explains how they work.
Roles: Everyone who can see the service reads its pages.
adminandeditorcreate, save and delete them, and manage labels.
Basics#
A page belongs to the service, not to a version. It is the same in every version, and publishing a specification never touches it. Its place in the left menu is part of the service structure. A new page appears at the end of the first level and can be moved like any other node.
A page opens at /docs/<service>/pages/<id>. Breadcrumbs show the folders around it. The row of the page in Service structure has buttons to edit and delete it.
Writing#
The editor (administrators and editors) is the same Markdown editor as for overlays, with a title field. See Markdown Overlays.
- A page holds up to 1 MiB of Markdown. A service can have up to 500 pages.
- The picture button, pasting a picture and dropping a file into the text upload it and put the link at the caret.
- Leaving the editor with unsaved changes asks first. A page changed by someone else while you edited it is refused with a message.
Pictures#
- Formats: PNG, JPEG, GIF, WebP or SVG. At most 5 MB per file, 50 pictures and 50 MB per page.
- Pictures are checked and sanitized. They are served so scripts cannot run.
- When a page is saved, pictures older than an hour that the text no longer links to are removed. Deleting a page deletes its pictures.
- Pictures need the session, so the interface loads them with it.
Labels#
Endpoints and text pages carry labels: short lower-case texts (letters, digits, spaces, -, _, up to 40 characters, at most 20 per item). The same word can be used on any number of items.
The line above a page shows the tags of the specification (not removable) and the manual labels. Administrators and editors add and remove labels. Labels do not depend on the specification version. Clicking a label narrows the left menu to the items that carry it. Labels of a page are deleted with it.
History#
Creating a page and every save keep the title and text as a numbered version (from 1) with its time and author. The History button opens the list (/docs/<service>/pages/<id>/history), and each version can be read on its own. Everyone who can see the service can read it. Nothing is restored from there. Pictures are not versioned: a picture deleted from the page does not show in an old version.
Search, export and MCP#
- Global search finds pages by title and text in services you can see. See Navigation and Search.
- The Export Wizard can include pages, with their pictures.
- AI clients can use
list_pages,get_page,list_page_versionsandget_page_version. See MCP Server.