Documentation Index
Fetch the complete documentation index at: https://mintlify.com/XxYouDeaDPunKxX/Signal-Rail/llms.txt
Use this file to discover all available pages before exploring further.
08_surface_map.txt answers a different question from the other canonicals. While 01_orientation.txt explains what the project is, 08 explains where it actually lives — which folders are real, which entrypoints are safe, which surfaces will cause outsized impact if touched incorrectly, and what the minimum requirements are to start working safely. A project that has a well-maintained 08 can be re-entered without guessing. One that lacks it forces every agent or operator to reconstruct technical reality from scratch each session.
What 08 is for
This file does not explain what the project is. It explains where the project really lives, which entrypoints are real, which points attract but lead you away, and which surfaces have high impact if touched. It exists to give a concrete reading of the real body of the project, not of its idea.What goes here
| Content | Why it belongs here |
|---|---|
| Active repos or folders | Shows where the project really lives |
| Real entrypoints | Shows where you truly enter the project |
| Places not to start from | Prevents wrong or too-costly entry |
| Sensitive files and surfaces | Shows where a small change can have large impact |
| Minimal runbook | Gathers only the minimum required to start, verify, and make a first safe touch |
| Critical env, config, or dependencies | Explains what truly changes the project’s behavior |
| Critical external integrations | Shows what the project touches outside its own files |
What does NOT go here
| What | Where it belongs | Why |
|---|---|---|
| Project identity | 01_orientation.txt | Explains what the project is, not where it lives |
| Hard-to-reopen constants | 02_protocol_freeze.txt | Stable constraints, not technical topology |
| Current live work | 03_master_working.txt | Present operational state, not technical map |
| Decisions already taken | 04_decision_log.txt | Already-won choices, not topology |
| Ideas, backlog, or latent material | 05_latent_ideas.txt | Not yet closed |
| Full manual, long setup, extended troubleshooting | Nowhere in Signal Rail | 08 should remain a minimal map, not total documentation |
| Total inventory of everything | Nowhere in Signal Rail | Not everything matters in the same way |
Template sections
08 uses seven categories of entries, each with its own template and an example drawn from the source file.
Repo / Folder
Records where the project really lives. Not for listing everything — for helping someone recognise which places matter when reading, opening, or touching the project.Entrypoint
Records where someone truly enters the project. Not convenient points, not nearby points — the points from which a real reading, start, or first sensible touch actually begins.Do Not Start Here
Records points that attract attention but can easily send you the wrong way. Naming false entrypoints explicitly protects against wrong entry even when the correct entrypoint is written.Sensitive Surface
Records points where a small change can have a large impact. Not for writing what makes you anxious — for making visible where the impact class changes if something is touched.Minimal Runbook
Records only the minimum required for startup, basic verification, and a first safe touch. Not a full setup or tutorial.Critical Dependency
Records only what truly changes the behavior of the project if it is missing or different. Not a list of everything around it.Critical Integration
Records only external integrations that truly change the behavior of the project.When to update it
Update08 when:
- The real topology of the project changes
- An entrypoint changes
- A sensitive surface changes
- A critical dependency changes
- The minimum required to start, verify, or touch the project safely changes
The ENTRIES START/END zone
Technical map updates use the append zone:Section hygiene
The section titles in08 are operational anchors. Keep them stable and do not duplicate them unnecessarily.
| Field type | Rule |
|---|---|
links to | Must point only to real canonical files or real IDs |
external reference | Use for useful files, paths, or materials outside the canonical set |
| Open slots | Acceptable only while a block is clearly template-like — not permanent noise in a live surface map |
Typical errors
Runtime Entry (00)
Entry gate — 08 is read conditionally when technical surfaces may be touched.
Orientation (01)
Project identity — the complement to 08’s technical topology.
Guided Prompts
Guided paths for safer surface-aware starts and routing passes.
Workstation Reference
The offline workstation for reading, staging, and previewing surface changes.