Contributing
This page is part of the v0.1.0-alpha.1 release path.
What You Will Do
Section titled “What You Will Do”- Validate documentation before submitting alpha-facing changes.
- Keep user journeys, reference pages, and troubleshooting notes in sync.
- Run the docs validator and strict Starlight build locally.
- Link release-impacting work to the alpha checklist when needed.
Commands
Section titled “Commands”make docs-validateuv run pytest testing/ci/tests/test_validate_docs_navigation.py -qContributor Workflows
Section titled “Contributor Workflows”- Remote DevPod workspace for heavyweight validation.
- Contributor testing for unit, integration, E2E, docs, and release-validation checks.
- Contributor troubleshooting for remote validation, tunnel, demo, lineage, trace, and stale-image failures.
- Documentation standards for keeping docs aligned with behavior.
Contributor workflows can use repo-local make targets and DevPod. Platform Engineer and Data Engineer docs should describe product workflows that do not require contributor infrastructure.
Success Criteria
Section titled “Success Criteria”- Alpha-critical documentation pages exist and are included in the docs manifest.
- Local relative Markdown links in required pages resolve.
- Validator tests pass after docs navigation changes.
- Pull requests explain which documentation surface changed.