Skip to content

FuncPipe Guide Index

flowchart TD
  reader["Capstone reader"] --> index["Guide Index"]
  index --> arrival["Arrival guides"]
  index --> code["Code and package guides"]
  index --> proof["Proof and review guides"]
  index --> change["Change guides"]
flowchart TD
  question["State the question you have"] --> section["Choose the matching section"]
  section --> file["Open one next guide"]
  file --> narrow["Keep the route narrow until the question changes"]

Use this page when you already know the capstone is the right place to look, but you do not yet know which local guide answers your question fastest. The goal is to keep the capstone doc set small and navigable instead of making learners rescan the README every time.

If you are just arriving

  • README.md
  • FIRST_SESSION_GUIDE.md
  • ARCHITECTURE.md
  • WALKTHROUGH_GUIDE.md

If you want the package and file route

  • ARCHITECTURE.md
  • CODE_ROUTE_MAP.md
  • PACKAGE_GUIDE.md
  • TEST_GUIDE.md

If you want the proof route

  • COMMAND_GUIDE.md
  • PUBLIC_SURFACE_MAP.md
  • PROOF_GUIDE.md
  • TEST_READING_MAP.md
  • REVIEW_ROUTE_MAP.md
  • TOUR.md
  • WALKTHROUGH_GUIDE.md

If you want to change the capstone honestly

  • ARCHITECTURE.md
  • EXTENSION_GUIDE.md
  • TEST_GUIDE.md
  • SOURCE_TO_PROOF_MAP.md

If you only need one next file

Choose based on the question you have:

  • "What does this capstone model?" -> README.md
  • "Which package owns this behavior?" -> ARCHITECTURE.md
  • "Which current files should I open first for this concept?" -> CODE_ROUTE_MAP.md
  • "What should I read first in the code?" -> PACKAGE_GUIDE.md
  • "Which tests prove this claim?" -> TEST_GUIDE.md
  • "Which proof should fail first for this claim?" -> TEST_READING_MAP.md
  • "Which command should I run?" -> COMMAND_GUIDE.md
  • "What did a command or artifact actually expose?" -> PUBLIC_SURFACE_MAP.md
  • "What is the shortest human reading route?" -> WALKTHROUGH_GUIDE.md
  • "Which guide and route fit this review pressure?" -> REVIEW_ROUTE_MAP.md
  • "Where should a change go?" -> EXTENSION_GUIDE.md
  • "How do I prove a package or boundary change?" -> SOURCE_TO_PROOF_MAP.md

Best next file after this one

If you do not have a sharper question yet, open README.md, then FIRST_SESSION_GUIDE.md, then CODE_ROUTE_MAP.md.