How-to guides¶
How-to guides are recipes. Each one takes a reader who already knows what they want through the steps to get it done. A guide serves someone working; it does not teach the basics.
What belongs here
- A title that names a goal: "How to…" or an imperative such as "Run the black-box tests".
- Steps for a real-world task, including the conditions or variations that matter.
- The assumption that the reader is competent, with no teaching detours.
What does not belong here
- Step-by-step learning for beginners → Tutorials
- Complete descriptions of options and formats → Reference
- Why things are the way they are → Explanation
Available guides¶
| Guide | Goal | Status |
|---|---|---|
| Add a repository | Bring a new repository online, consistent with every other repository | Ready |
| Set up a language repository | Wire a new implementation repository to the curriculum | Ready |
| Run the black-box tests | Run the public and hidden suites against your build | Ready |
| Contribute documentation | Add or change a page on this site | Ready |
Status: Ready pages are complete. Draft pages describe their planned content and audience.