Reference¶
Reference pages are descriptions. They state the facts about the machinery accurately, completely, and neutrally, organized to mirror the structure of the thing they describe. Readers consult reference material while they work. They don't read it from start to finish.
What belongs here
- Austere, factual descriptions: repositories, projects, tools, options, formats, statuses.
- A consistent structure, so the same kind of fact is always in the same place.
- Short usage examples that illustrate, never teach.
What does not belong here
- Guided learning → Tutorials
- Steps to achieve a goal → How-to guides
- Opinions, history, and rationale → Explanation
Sections¶
| Section | Describes |
|---|---|
| Repositories | Every repository in the organization, its purpose, and its status |
| Container tooling | The shared container-first tooling: runtimes, variables, targets, images, CI jobs |
| Organization settings | Organization, Actions, security, repository, branch-protection, and CI settings, and where each is defined |
| Curriculum | The fifty-three curriculum projects, their tools, where each specification lives, the current release, and which languages implement each project |
| Languages | The language implementation repositories, their toolchains and project tooling, and the projects each implements |