Capabilities

What Pinnate docs and the platform include today, and what is coming soon.

Pinnate combines an OpenAPI registry, hosted docs sites, SDK/CLI generation, and agent workflows.

Shipped

Area	What you get
Registry	Versioned OpenAPI, JSON Schema, Spectral rulesets; public or private; git sync
Docs sites	Markdown guides, `site.yaml` navigation, API/SDK/CLI embeds, custom domains, redirects, public/private
Git sync	BYO GitHub/GitLab for APIs, schemas, rulesets, and sites
Editor	Console WYSIWYG for guide pages
SDKs / CLIs	Multi-language generation and publish workflows
Agents	REST API + MCP for list/create/update/publish
Theme	Accent color, light/dark logo URLs, favicon URL, `full` / `centered` layout
Guide components	Markdown directives for callouts, steps, cards, and tabs
SEO / agents	Open Graph meta, `/robots.txt`, `/llms.txt`, page `.md` mirrors, `site.yaml` redirects
Search	Command palette (⌘K) via Meilisearch over published page titles, descriptions, headings, and body content
Sidebar	Page icons from frontmatter
Top-level tabs	`sections:` header tabs with optional icons and per-tab sidebars
API reference layout	`api_layout` to reorder/hide tags & operations, flatten nav
Doc versions	Header switcher over recent publishes (`site.yaml` `versions:` / `?v=`)
Preview links	Generate a branch snapshot from Integrations (`?v=preview/…`) without changing production

Section	Contents
Get started	Quickstart, concepts, project structure
Sites	Hosted docs, `site.yaml`, writing, embeds, domains
Registry	APIs, schemas, rulesets, versions
SDKs	Generate and publish clients
CLIs	Generate command-line tools
Agents	REST API and MCP
Organizations	Tenancy and members
API keys	Automation credentials
Reference → API reference	Live OpenAPI embed
Reference → SDK reference	Live SDK docs embed

Tracked in beads epic docs-oxf (plus UX issues under docs-1qq).

Area	Stub	Beads
Changelogs	Changelogs	docs-oxf.3
Reusable snippets	Snippets	docs-oxf.8
Rich media embeds	Media	docs-oxf.6
Docs MCP (tool-calling)	MCP	docs-oxf.12 follow-up
Ask AI	Ask AI	docs-1qq.6
Agent skills hosting	Agent skills	docs-oxf.13
Theme typography / palette	Theme	docs-1qq.7
Custom CSS / header / footer	Custom CSS, Header and footer	docs-oxf.9, docs-oxf.10
Password gate	Password	docs-oxf.11
Multi-source publish	Project structure	docs-oxf.5
Localization	Localization	docs-1qq.8
Path-prefix / reverse proxy	Domains	docs-oxf.14
Markdown in API reference tree	Layout	docs-oxf.20
Repo assets CDN upload	Project structure	docs-oxf.19

Closest shipped alternatives are linked from each stub (for example registry versions vs doc versions).