docs
|
|
| Site |
https://docs.xvii.network (/en/…, /ru/…) |
| API |
https://docs.xvii.network/api/v1 (nav, pages, search, meta), public |
| For language models |
/llms.txt, /llms-full.txt, <page>.md, MCP at /mcp |
What it does
- The documentation of the installed version: the pages are built into the binary, so they always
match what the instance runs, and use its domain in examples.
- Two languages, chosen by the address, a saved choice or the browser.
- Search over titles, headings and text (⌘K or
/).
- Readable without JavaScript: every page is rendered on the server, with links to its other language
for search engines, a sitemap and
robots.txt.
- Markdown for every page: add
.md to its address, or Copy page.
- MCP tools
search_docs and read_doc for agents.
- Public: no sign-in needed.
Writing documentation
The pages are Markdown in the docs repository (content/en, content/ru). make serve runs the site
from a checkout and reloads on every save. The format (front matter, callouts, tabs, steps, cards) is
described in the repository's services/docs.md, under Internals.
Later
Documentation sites for teams: publish a folder of Markdown from a repository or the CLI and get the same
layout, search and languages at <site>.docs.xvii.network or your own name.