Reference overview
How the SEIF reference docs stay correct — generated from canonical sources, never hand-copied.
The reference section is generated from the source of truth, not written by hand. This is how the docs stay correct as the product evolves — the same idea behind the React, Docker, and Git documentation sites.
CLI reference
Every command and flag, generated from the CLI's own command tree.
MCP tools
The Model Context Protocol tool catalog exposed by seif mcp serve.
HTTP API
The engine's REST surface, generated from its OpenAPI specification.
How generation works
A single script, scripts/sync-docs.mjs, pulls each reference page from its
canonical generator:
| Page | Source of truth |
|---|---|
| CLI reference | the CLI command tree (generate_docs) |
| MCP tools | the MCP catalog (generate_mcp_reference) |
| HTTP API | the engine OpenAPI spec (/v1/spec/openapi.json) |
| Protocol codex | the CODEX registry |
Generated pages pass scripts/check-doc-leaks.mjs before they are committed, so
no machine-specific path, hostname, or personal identity can reach the public
site. Regeneration runs automatically when main is updated.
Placeholder pages
The individual reference pages are seeded as placeholders until the generation
pipeline lands. Once wired, they refresh on every pull to main.