Unreleased
What has landed on main since RC4, regenerated on every build of the site: the in-progress app notes and REST API 1.303.0 to 1.339.1 (29 versions).
What has landed on main since RC4, regenerated on every build of the site: the in-progress app notes and REST API 1.303.0 to 1.339.1 (29 versions).
The Admin & tools group now covers every operator screen — the admin console, Users, Tenants, Licenses, Feature flags, Sign-in providers, Property templates, the Data browser and Migrations — and Operating Apiome links the runbooks, the environment reference and the Compose stack. (#5627)
The Bring in group now has a page for every screen in it — the Catalog and each item's tabs, both import wizards with a worked example per source, Repositories, MCP servers and Agent access. (#5623)
The Build group now has a page for every screen in it — Projects, Versions and its tabs, Version dialogs, Primitives and types and Studio — with a light and dark screenshot of each tab and dialog. (#5622)
Documentation is now part of the definition of done. yarn docs:check runs on every pull
request — not only those that touch the docs — so a change to a product screen or an endpoint
cannot merge with its page, screenshot or reference behind it.
(#5630)
The documentation site now ships as a Docker image, so you can serve it next to your own Apiome installation. See Host the documentation site.
Apiome has a documentation site. It is grouped by the job you are doing — Getting started, Build, Bring in, Ship, Govern, Workspace & account, Admin & tools and Reference — follows your system's light or dark theme, and is searchable from the navbar. (#67)
Reference now carries the three surfaces generated straight from their source, so they cannot drift from it: the REST API — a page for each of its tags — the CLI — a page for each command, plus the exit codes — and the MCP server's tools. (#5628)
Getting started now walks the whole spine as it ships today — sign in, set up your organization, find your way around, import a project, version and publish it, browse and export it, and connect an MCP host — with a light and dark screenshot of every screen along the way. (#5621)
The Govern group now has a page for every screen in it — Style guides with the rule catalog, custom rules, assignment and policies, Lint posture, the Access audit and Reviews and the approval gate. (#5625)