docs
|
|
| Сайт |
https://docs.xvii.network (/en/…, /ru/…) |
| API |
https://docs.xvii.network/api/v1 (nav, pages, search, meta), публичный |
| Для языковых моделей |
/llms.txt, /llms-full.txt, <страница>.md, MCP на /mcp |
Что делает
- Документация установленной версии: страницы встроены в бинарник, поэтому всегда соответствуют тому, что
запущено на инстансе, и используют его домен в примерах.
- Два языка — по адресу, сохранённому выбору или языку браузера.
- Поиск по заголовкам, разделам и тексту (⌘K или
/).
- Читается без JavaScript: каждая страница рендерится на сервере, со ссылками на другую языковую версию
для поисковиков, картой сайта и
robots.txt.
- Markdown для каждой страницы: допишите
.md к адресу или нажмите Скопировать страницу.
- MCP-инструменты
search_docs и read_doc для агентов.
- Внешний вид инстанса: имя, логотип, акцентный цвет и фон из home, статья поверх фона — на стеклянной
карточке.
- Публичная: вход не нужен.
Как писать документацию
Страницы — Markdown в репозитории docs (content/en, content/ru). make serve запускает сайт из рабочей
копии и перезагружает его при каждом сохранении. Формат (front matter, выноски, вкладки, шаги, карточки)
описан в services/docs.md репозитория, в разделе Internals.
Дальше
Сайты документации для команд: опубликуйте папку Markdown из репозитория или CLI и получите тот же макет,
поиск и языки на <сайт>.docs.xvii.network или своём имени.