Skip to content

Contributing

Read the documentation contract. Spokes use Markdown only during the MVP. Arbitrary MDX is not allowed in Spoke docs.

Each Spoke owns its documentation and, if it wants, its own Docs check / dispatch workflows. The private Hub does not publish reusable Actions. Spokes keep their own PR title and template conventions.

Spoke CI does not require a docs update for code changes. If Docs check runs, it only validates Markdown when docs/ changed. Reviewers request documentation when a change is user-facing. Hub ingest still rejects invalid Markdown at publish time.

If the Spoke has dispatch CI, a trusted push to main that touches docs/** notifies the Hub. You can also run Hub Build staging manually. Watch fetch, ingest validation, build, and deploy there.