Skip to content

Contributing

This is the documentation-site entry point for contributors. Detailed workflow lives in the root repository documents rather than being copied into the site.

Start here

Common change paths

ChangeStart with
Extension behaviorextensions/<id>/index.ts, relevant lib/, and focused tests
Extension metadata or agent-document rolesextensions/<id>/manifest.json
Shared behaviorlib/common/README.md and the owning shared Module
Generated documentationChange its manifest/source input, then run npm run generate-catalog
Contributor workflowRoot CONTRIBUTING.md
Stable architecture decisionA focused ADR under docs/adr/

Source-of-truth rules

  • Code and Behavior Proofs define implemented behavior.
  • Manifests declare generated/runtime surfaces and document roles.
  • Generated files and generated marker blocks are never hand-edited.
  • Extension behavior stays co-located under extensions/<id>/.
  • Shared helpers belong in lib/common/ only when multiple extensions need the same behavior.

Validation

Run focused checks while iterating. Before publishing broad changes, use:

bash
npm run lint
npm run validate:ci

Useful documentation checks:

bash
npm run generate-catalog:check
npm run docs:health:check
npm run docs:build

If generated drift is reported, run npm run generate-catalog, review the full diff, and stage the intended outputs explicitly.

Released under the Apache-2.0 License.