Skip to content

Reference

Use the reference section when you need exact interfaces, command destinations, or failure-path guidance more than narrative. It is the site's precision layer.

Reference matrix

If you need...Start hereScope
reusable helper APIs and module-level headersAPI Referenceentry hub for documented English-only API detail pages
fast answers to recurring setup and workflow questionsFAQhigh-frequency questions with short answers
build, runtime, or benchmark failure recoveryTroubleshootingoperational diagnosis routes
source material behind the methodologyResearch Referencesstandards, manuals, repositories, and articles
module-to-code mappingModule Atlasarchitectural orientation rather than API details

Command lookup

TaskCanonical route
baseline validationcmake --preset=debug && cmake --build build/debug && ctest --preset=debug
optimized validationcmake --preset=release && cmake --build build/release && ctest --preset=release
memory-safety passcmake --preset=asan && cmake --build build/asan && ctest --preset=asan
race detectioncmake --preset=tsan && cmake --build build/tsan && ctest --preset=tsan
undefined-behavior passcmake --preset=ubsan && cmake --build build/ubsan && ctest --preset=ubsan

English-only detail pages

Low-level detail pages under reference/api/ remain English-first by design. They document code surfaces such as memory utilities, SIMD wrappers, and benchmark helpers where precision matters more than translation coverage.

Relationship to other sections

  • use the Playbook when you need a guided workflow
  • use Architecture when you need system context
  • use Research when you need external citations or historical framing

The reference hub is intentionally compact. It is meant to stay stable even when other narrative surfaces deepen.

Released under the MIT License.