Skip to content

Guide Index

Guide Maps

graph TD
  guide["GUIDE_INDEX.md"]
  route["Route selection"]
  local["Local capstone guides"]
  code["Source files"]
  proof["Commands and tests"]

  guide --> route --> local
  local --> code
  local --> proof
flowchart LR
  question["Pick the question you have"] --> local_guide["Choose the smallest local guide"]
  local_guide --> inspect["Inspect the command, file, or bundle it names"]
  inspect --> answer["Return with one concrete ownership or proof answer"]

Use this page when the capstone root shows many guide files and you need one durable starting point. The goal is not to read every document. The goal is to open the smallest local guide that matches the question you actually have.

Start here by question

"What is this project, and how should I enter it?"

"Which file owns which mechanism?"

"Which command should I run first?"

"How do I inspect the public runtime shape?"

"How do wrappers, fields, and constructors work?"

"How do I review or extend the project safely?"

"How do I read the saved review bundles?"

Escalation rule

Use the smallest guide that answers the current question, then stop.

  • Move to source files only after the guide names the owning file.
  • Move to tests only after the guide names the claim that still needs proof.
  • Move to saved bundles only when another reviewer needs a durable artifact.

Best next files after the guide index

  1. README.md
  2. FIRST_SESSION_GUIDE.md
  3. ARCHITECTURE.md
  4. COMMAND_GUIDE.md

That route gives the learner the project promise, the first-session route, the ownership model, and the command route before they drop into code.