Mandatory Nimbus documentation profile

This profile is activated automatically in all projects. It transforms classified Markdown files into documentation that people and agents can navigate, search, and consume.

Profile type

• Mandatory standard. This profile implements P03, P04, P09, P10, P13, P14, P16, and P17.
• Canonical engine. Nimbus is a foundation invariant. A local exception cannot remove it.
• Single source. Markdown files classified by documentation.json remain the editorial sources. The Nimbus collection is generated and ignored by Git.

Versioned installation

• Keep the scaffold in docs-nimbus/ and track it with nimbus.json.
• Use Node 22.12.0 or later.
• Pin @cloudflare/nimbus-docs to 0.8.2 and commit the npm lockfile.
• Record the version, configuration directory, and canonical command in PROJECT.md.
• Create an ADR if Nimbus becomes a published surface.
• Do not copy an adapter from another project without review. Front matter, callouts, links, and indexes are local contracts.

Collections and audiences

• Consume documentation.json or a deterministic adapter derived from this manifest.
• The local build can combine all collections for navigation and verification.
• Publish only explicitly authorized collections. Publish public collections by default.
• Keep internal collections, secrets, sensitive runbooks, and private evidence out of the public build.
• Include reference collections only if their audience and stability permit it.
• Keep archives identifiable as historical and not current.

Sources and derived artifacts

• Do not modify the collection generated by Nimbus.
• Test each conversion of front matter, links, anchors, callouts, or indexes.
• Regenerate from sources before type checks, build, and lint.
• Ignore the generated collection and site in Git unless a justified decision specifies otherwise.
• Deliver source, adapter, configuration, and navigation changes together.

Verification

The canonical documentation command must run at least:

1. complete catalog verification;
2. adapter tests;
3. site type checks;
4. static build;
5. indexing or search;
6. Nimbus lint;
7. a browser review of affected audiences and routes.

Local output is not proof of publication. Separately verify the delivered URL, base path, indexing, and Markdown or llms.txt variants.

Update or removal

• Read upstream changes and run nimbus-docs outdated from the Nimbus package.
• Update the version and lockfile in an isolated work unit.
• Run the adapter, complete build, and route review again.
• Keep a rollback path to the last verified artifact or commit.
• Removing Nimbus requires a new Project Foundation version and an ADR that supersedes ADR-0003.

Minimum gate

• each maintained Markdown file classified exactly once;
• no internal collection in the public output;
• pinned Nimbus version and lockfile;
• generated collection absent from Git;
• adapter tested;
• successful build, search, and lint;
• final navigation and routes verified;
• publication limitations recorded explicitly.