Documentation Infrastructure¶
Short summary¶
Documentation Infrastructure defines how infrastructure documentation is authored, reviewed, validated, and published as an engineering asset.
Why this area matters in S-CORE¶
The infrastructure is evolving and spread across multiple repositories. Clear, current, and maintainable documentation is required for contribution, planning, and stakeholder transparency.
Scope¶
- information architecture and navigation quality
- documentation authoring and review practices
- MkDocs build validation and publication workflows
- cross-linking between areas, guides, and work packages
Boundaries / what is not covered here¶
- ownership of all technical details in other areas
- non-repository documentation systems
- infrastructure operations ownership outside documentation workflows
Main tools and technologies¶
- Markdown
- MkDocs
- uv-managed documentation toolchain
- GitHub Actions documentation validation and publishing workflows
Current state¶
Docs-as-code foundations are in place and functioning. Content quality, consistency, and cross-link coverage are improving but not yet complete.
Key work packages¶
- keep navigation compact and area-centered
- strengthen contributor-facing guidance quality
- improve documentation ownership and review cadence
- maintain reliable validation and publishing workflows
How contributors can help¶
- improve contributor-facing documentation clarity
- add missing cross-links between related pages
- rewrite ambiguous or outdated instructions
- improve practical examples in guides