Documentation
SEO
Docs are how people find your API. Every page carries the metadata search engines and link previews read, and you control it per project.
Settings
| Setting | What it does |
|---|---|
| Meta title | Site name, and the static title when the title mode is static |
| Title template | Pattern for per-page titles, with %s as the page title |
| Meta description | Fallback description when a page has none |
| Open Graph image | The image link previews show |
| Favicon | The browser tab icon |
| Keywords | Meta keywords |
| Indexable | Whether search engines may index the site |
Titles
Two modes:
%s is replaced with the page title:
%s | Acme API -> List users | Acme APIBetter for search: each page gets a distinct, descriptive title.
Indexable
indexable: false emits noindex, nofollow on every page. It's what you want on a staging site, and catastrophic if it survives to production: your docs quietly vanish from search and nothing looks broken.
Canonical URLs
Each page emits a canonical URL built from your docs base URL, so the same content served on both your Octri subdomain and your custom domain isn't treated as duplicate content. The canonical follows the domain the reader is on.
Open Graph
The OG image is what appears when someone drops a link in Slack. Without one, the preview is a bare title and URL.
A single branded image applied site-wide covers every share. Per-page images are a nice-to-have that mostly go unshipped.
What you get without configuring anything
Sensible defaults: the project name as the site name, the page title as the title, and a description derived from the page. Configure the settings to improve on that, not to make it work.