Contributing

Before you write

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

Spoke pull requests

Use this title format:

<type>(<scope>): <short description>

Examples:

• docs(potpie-spoke): add installation guide
• feat(cli): add authentication command

Every PR description must include summary, user-facing impact, documentation impact, files updated, testing performed, and related issue or specification.

Include this checklist:

## Documentation impact

- [ ] Documentation was updated in this PR.
- [ ] Documentation is not required.

Reason documentation is not required:

<!-- Explain why and request the docs-not-required label. -->

User-facing code changes require documentation in the same PR unless an authorised maintainer applies docs-not-required with a written reason.

After merge

A trusted push to main that touches docs/** sends repository_dispatch to the Hub. Watch the Hub Build staging workflow for fetch, validation, build, and deploy results.