Mykola merges docs pull requests. One named person, not a rota: a page's author cannot be the one who reviews and merges it, or there is no review — only a second commit.
A docs pull request waits at most 48 hours. That is a ceiling, not a target. Same-day is the common case, and nothing here asks a reviewer to sit on a ready page. If 48 hours pass with no merge and no review comment, the pull request is not stuck behind etiquette — ping directly and treat it as escalated.
- Branch off
main. - Edit or add a
.mdfile at the top level of this repo. - Open the pull request against
main.
main is protected: changes land through a reviewed pull request, never a direct push.
A page that breaks either one does not publish. The rest of the site is unaffected, and the docs host states the failure rather than serving a stale copy — so a broken page is visible, not silent.
1. Every page starts with a single # heading. That heading becomes the page title and
its entry in the site navigation. There is no front-matter and no separate title field: the
heading you write is the title, in one place.
# Getting started
Body starts here.2. Markdown only — no raw HTML. These pages are published to a live host, so a raw tag would be served verbatim to every reader. Write Markdown and the publisher renders it. Angle brackets inside fenced code blocks and backticks are fine — that is content, not markup, and the rule does not apply there.
Match what is already here. Short sentences. Say the concrete thing rather than the impressive one. Every claim about the API should be one you have actually run — the getting-started page was smoke-tested command by command before it shipped, and that is the bar.
Link to the generated API reference for field-by-field detail instead of restating it. The reference is regenerated from the live API; anything copied out of it here starts rotting immediately.