docs
|
|
| Site |
https://docs.dvxch.team (/en/…, /ru/…) |
| API |
https://docs.dvxch.team/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.
Team documentation (v2)
Open docs.dvxch.team/spaces and create a space for your team: a product's docs, a wiki, an API
reference. Start blank or from a template (product docs, team wiki, API reference), or import a folder of
Markdown, a Notion, GitBook, Docusaurus or MkDocs export — their navigation order comes along.
Developers of the team write and publish, viewers read drafts and comment, admins manage access and
settings. Guests from outside the team can be invited to one space as editors or commenters.
Writing
The space's pages are in the sidebar under its sections: click to open, drag to reorder or nest, ⋯
to add a subpage, rename, duplicate, move (also to another space of the team), hide or delete (the trash
keeps pages 30 days). The page opens edge to edge, like a notebook:
- Type
/ for a block — headings, lists, tasks, quotes, callouts, code, tabs, steps, cards, tables,
images, files, embeds, API references, links to other pages — or use Markdown shortcuts (## , - ,
```). Pasting Markdown gives blocks.
- Select text for its toolbar: bold, italic, strike, code, link, AI, comment.
- Hover a block for its handle: drag it, add a block below, duplicate or delete it.
- Several people edit at once and see each other's cursors; offline edits merge when you reconnect.
- Comments and History are at the top right of the page: comments are anchored to the text,
with replies, mentions and resolve; any earlier version can be compared and restored.
Each language of the space has its own text of the page; switch it in the bar above the page. A page
without a translation shows the default language to readers.
Publishing
Readers never see the draft. Publish shows what changed page by page and warns about broken links;
the publication is then frozen, so later engine upgrades never change it. Publications lists them:
make an earlier one live again, name one as a version (v1) that readers pick in the site header, or
restore it as the draft. Preview opens the draft as a reader would see it.
Sharing and settings
- Settings → Access: team and guests, everyone signed in to the instance, anyone with the secret link
(optionally with a password), or public. Sharing invites guests and makes links to the space or a
single page, with an expiry and a password.
- Settings → Custom domains: every space is at
<address>.docs.dvxch.team; Attach a domain opens
xvii domains, which creates the records and the certificate.
- Settings → Appearance: name, logo, favicon, accent, background, header and footer links, a landing
page for the home page. What you leave empty follows the instance's look.
- Settings → General: readers' "Was this page helpful?", and Count readers, which makes a site in
xvii analytics for the space (no cookies). Insights shows feedback and searches that found nothing.
- Settings → Git source: keep pages in a GitLab or GitHub repository; a webhook syncs each push into
the draft, and those pages are edited in the repository. After you disconnect the repository, Make
editable turns its pages into ordinary pages of the space.
AI
In Settings → AI, Connect xvii AI gives the space its own key of the team (nothing to copy; it is
revoked when you disconnect) and picks a model. Editor AI assistance rewrites, shortens, fixes,
continues, translates into another language of the space or summarizes a page into its description —
always as a suggestion you review. Reader AI answers lets readers ask questions answered from the
published pages, with links to them. Usage counts against the team's AI limits.
API references
Insert API reference or import an OpenAPI 3 document (JSON or YAML, a file or an HTTPS address): the
page lists endpoints with parameters, schemas and examples in curl, JavaScript, Python and Go. Send
request calls the API from the reader's browser (the API must allow CORS); nothing is sent through
docs and credentials are never saved. The document is frozen with each publication.
From the terminal, CI and agents
xvii docs spaces # spaces of your teams
xvii docs create "Handbook" --template wiki
xvii docs publish ./docs --space product # a folder of Markdown becomes the draft and is published
xvii docs pull --space product docs # the draft back as Markdown
In CI, XVII_TOKEN or the job's OIDC token (under the team's trust rules in id) signs in. Agents can use
docs.dvxch.team/mcp with a token: list spaces and pages, read, create and update pages from Markdown,
and publish.