|
| 1 | +# Loop Documentation |
| 2 | + |
| 3 | +Welcome to the part of the project where we admit future-you exists. |
| 4 | + |
| 5 | +This documentation is organized by audience and workflow, not by who happened to write the last markdown file at 2:13 AM. |
| 6 | + |
| 7 | +## Choose Your Path |
| 8 | + |
| 9 | +| If you are... | Start here | Then go to | |
| 10 | +|---|---|---| |
| 11 | +| New to Loop | [User Guide](./user-guide/README.md) | [Workflow Recipes](./user-guide/workflow-recipes.md) | |
| 12 | +| Building features | [Developer Guide](./developer-guide/README.md) | [Quality Gates](./developer-guide/quality-gates.md) | |
| 13 | +| Debugging internals | [Internals](./internals/README.md) | [Troubleshooting](./troubleshooting/README.md) | |
| 14 | +| Looking for architecture rationale | [Concepts](./concepts/README.md) | [ADR Index](./adr/) | |
| 15 | + |
| 16 | +## Documentation Map |
| 17 | + |
| 18 | +### User-Facing |
| 19 | +- [User Guide](./user-guide/README.md): Start-to-finish guidance by skill level. |
| 20 | +- [Workflow Recipes](./user-guide/workflow-recipes.md): End-to-end task playbooks. |
| 21 | +- [Power User Playbook](./user-guide/power-user-playbook.md): Performance, scale, and control. |
| 22 | + |
| 23 | +### Developer-Facing |
| 24 | +- [Developer Guide](./developer-guide/README.md): Build and change Loop safely. |
| 25 | +- [Setup](./developer-guide/setup.md): Environment bootstrap. |
| 26 | +- [Quality Gates](./developer-guide/quality-gates.md): Tests, checks, governance. |
| 27 | +- [Contribution Workflow](./developer-guide/contribution-workflow.md): Branch-to-merge routine. |
| 28 | + |
| 29 | +### Architecture and Internals |
| 30 | +- [Concepts](./concepts/README.md): Mental models and design vocabulary. |
| 31 | +- [Internals](./internals/README.md): Runtime architecture and module boundaries. |
| 32 | +- [Architecture](./internals/architecture.md): System structure and data flow. |
| 33 | +- [OODA + Execution Flow](./internals/ooda-and-execution.md): Observe/Orient/Decide/Act mapping. |
| 34 | +- [Module Map](./internals/module-map.md): Where behavior actually lives. |
| 35 | + |
| 36 | +### Operational and Recovery |
| 37 | +- [Troubleshooting](./troubleshooting/README.md): Fast diagnosis and fix paths. |
| 38 | +- [Common Issues](./troubleshooting/common-issues.md): Known failure patterns. |
| 39 | +- [Diagnostics Checklist](./troubleshooting/diagnostics-checklist.md): Structured incident capture. |
| 40 | + |
| 41 | +### Reference and Specifications |
| 42 | +- [Specification Set](./spec/): Canonical feature contracts (SPEC-20 through SPEC-27). |
| 43 | +- [Execution Plan](./execution-plan/README.md): Program-level planning, evidence, and governance. |
| 44 | +- [Architecture Decisions](./adr/): Long-lived technical decisions and context. |
| 45 | +- [Glossary](./glossary.md): Shared terms and definitions. |
| 46 | +- [Writing Style](./writing-style.md): Documentation voice and formatting contract. |
| 47 | + |
| 48 | +## Documentation Principles |
| 49 | + |
| 50 | +1. Behavior over aspiration: document what exists and runs. |
| 51 | +2. Workflow over component: prefer "how to get outcome X" over "here is a list of modules". |
| 52 | +3. Reproducibility over vibes: include concrete commands and expected outputs. |
| 53 | +4. Honesty over smoothness: if something is sharp, say so plainly. |
| 54 | +5. Friendly precision: direct writing, with enough personality that reading it does not feel like filing taxes. |
| 55 | + |
| 56 | +## Suggested Reading Order |
| 57 | + |
| 58 | +1. [Concepts: Mental Model](./concepts/mental-model.md) |
| 59 | +2. [User Guide](./user-guide/README.md) |
| 60 | +3. [Developer Setup](./developer-guide/setup.md) |
| 61 | +4. [Internals Architecture](./internals/architecture.md) |
| 62 | +5. [Troubleshooting](./troubleshooting/README.md) |
| 63 | + |
| 64 | +## Scope Note |
| 65 | + |
| 66 | +The docs in this folder are the operational surface. Deep design history and migration rationale still live in long-form docs such as: |
| 67 | +- `docs/unified-rlm-library-design.md` |
| 68 | +- `docs/lean-formal-verification-design.md` |
| 69 | +- `docs/migration-spec-recurse.md` |
| 70 | +- `docs/migration-spec-rlm-claude-code.md` |
| 71 | + |
| 72 | +Those are excellent references; they are not where a newcomer should start unless they really enjoy scrolling. |
0 commit comments