Skip to main content

The user guide moves onto the site

The Apiome team
The Apiome team

All 39 guides that lived in the repository's docs/guide/ folder are now pages on this site, grouped by job: Bring in, Build, Ship (with its own Mocks section), Govern and Reference. (#5619)

  • Search and a sidebar replace the old hand-kept “How do I…?” table.
  • New page: Run Apiome locally — the old index's Before you start section.
  • In the app, Help & docs — the guide search, the User guide and API & CLI reference cards — and every “View rule” and algorithm link open the page on this site.
  • Old links keep working. docs/guide/README.md maps each old file to its new page, and a lint result that still names a docs/guide/ page opens the new one.
  • Generated pages stay generated. Supported formats, Built-in lint rules and the three MCP rule catalogs are written by the same generators, now straight into the site, and the format counts in Import a specification and Export a spec still regenerate.