S-CORE Infrastructure Documentation¶

This site organizes S-CORE infrastructure documentation using four distinct content types, each serving a different reader need.

Documentation Map¶

	Learning	Working
Practical	Tutorials	How-to Guides
Theoretical	Explanation	Reference

Tutorials¶

Step-by-step lessons for newcomers. Follow along to build understanding.

• Getting Started — Set up your environment and run your first build
• Your First Pull Request — From fork to merged PR, end to end
• Creating a New Module — Start a new Bazel module from the template

How-to Guides¶

Practical recipes for specific tasks. Assumes you already have a working environment.

• Building with Bazel — Registry, dependencies, toolchains, lock files
• Testing — Test frameworks, coverage, sanitizers
• Code Quality — Pre-commit, lint policies, copyright headers
• Publishing Modules — Release, registry import, consumer access
• Writing Documentation — MkDocs setup, local preview, strict builds

Reference¶

Factual lookup material. No narrative, just the data you need.

• Quick Reference — Repositories, commands, links
• Configuration Reference — .bazelrc, pre-commit, devcontainer settings
• CI & Workflow Reference — Reusable workflow inputs, outputs, and secrets
• Tool Versions — Version matrix for shared toolchains and images

Explanation¶

Architecture, design rationale, and maturity assessment of each infrastructure area.

• 1. Source Code Infrastructure
• 2. Developer Environment
• 3. Build & Dependencies
• 4. Testing
• 5. Code Analysis Infrastructure
• 6. Compliance & Dependency Analysis
• 7. Automation & CI
• 8. Release & Distribution
• 9. Documentation & Traceability
• 10. Infrastructure Operations