Skip to main content

A user guide, an administration guide and a CLI guide

The Apiome team
The Apiome team

The documentation is no longer one long sidebar. The top bar now has four guides, each with its own sidebar and home page: the User guide for working in Apiome, the Administration guide for running an installation, the CLI for the apiome command, and the Reference for the REST API, MCP, the mock runtime and CI.

  • Same addresses — every page keeps its URL, so bookmarks and the in-app help links still work.
  • The user guide's home is the site root: the jobs in the order of the product's navigation rail, with links to the other guides.
  • The CLI guide puts the quick-start first and then a page per command, under Command reference.