skip to content

Contribute

Help maintain the docs, the specification and the registry, and learn the checks a contribution must pass.

awaiting reviewupdated view markdown ->
for humans

The documentation site and the specification are public and Apache-2.0. Anyone can open a pull request. The rule is the same for every contribution: cite the canonical source or a dated verification record, keep rendered text ASCII, and do not restate normative text on a product page.

What you can contribute

  • A docs page or fix. Add a page from a template, correct a broken step, or update a claim after a behavior change. Start with Contribute to the docs.
  • A specification change. Propose a protocol change with compatibility and conformance evidence. Start with Contribute to the spec.
  • A registry entry. Publish a conformant discovery document and add the evidence to the implementation registry.
  • A harness check. Re-run an install or signup flow and report the exact client version, tier and date.
  • A reproducible example. A runnable sample or fixture that other readers can repeat.

How review works

A page drafted by an agent stays marked aiGenerated: true and shows "awaiting review". Only a human reviewer clears the flag, after checking the page against its source and running the steps it contains. The reviewer records the result in the pull request and sets lastReviewed to the date of the review.

No review means no reviewed date. Do not clear the flag for someone else, and do not invent a verification date.

Read the rules

Paths through this section

Page Use it for
Contribute to the docs Page types, provenance, voice, review and the checks a docs change must pass.
Contribute to the spec The spec change process, conformance evidence, and how the docs pick up a release.
Local development Clone, run, build, sync and check the site.

Next

Start with Contribute to the docs for the templates and the review checklist, then run the site locally with Local development. For the contract itself, read Protocol.

sections

type to search.

up/down navigateenter selectesc close