Skip to content

Playbook

The playbook is the operational layer of the site. It keeps the runnable guides together so that readers can move from first build to profiling and hardening without re-learning the repository layout.

Operating principle

Use the playbook when you know what you need to do but not yet which file or page carries the command. It regroups existing guides without physically moving them, which keeps links stable while giving the site a clearer expert-facing narrative.

Runbook matrix

NeedStart hereOutcome
confirm toolchain and platform assumptionsPrerequisitesa correct local environment before builds start
install dependencies and produce binariesInstallationa configured repository with fetched dependencies
reach the first verified runQuick Starta baseline build and test pass
study modules in sequenceLearning Patha guided reading order across topics
diagnose a hot pathProfiling Guideprofiler-first evidence for the next change
choose an optimization tacticOptimization Decision Treea narrowed set of candidate interventions
harden low-level code before closureValidation & Sanitizersmemory, race, and UB checks
review project-wide habitsBest Practicesdurable rules that stay aligned with the repository posture
  1. Run Prerequisites and Installation once.
  2. Use Quick Start to prove the repository builds cleanly.
  3. Choose a topic via the Academy or Learning Path.
  4. When optimizing, switch to Profiling Guide and Optimization Decision Tree.
  5. Before declaring victory, run Validation & Sanitizers.

Secondary support surfaces

  • Exercises remain available for deliberate practice, especially when you want to reproduce a concept in isolation.
  • AI Workflow remains a contributor-facing route rather than part of the core reader journey.
  • Reference is the right place to land when you already know the topic and need exact commands or API details.

Why the playbook matters in a whitepaper

A whitepaper without runnable routes risks becoming ornamental. The playbook keeps that from happening. It is the operational proof that the architectural and research pages are attached to a live repository, not merely to a polished narrative.

Released under the MIT License.