54e6bfc0d0
Implements the 4-phase documentation reorganization master plan. - Consolidation: Merged brief/, handoff/, planning/, and decisions/ into briefs/, handoffs/, plans/, and adr/ respectively (101 ADRs relocated) - Root Cleanup: Relocated HANDOFF-gpt55-*.md and key top-level docs (runtime_contracts.md, etc.) to canonical folders. Added superseded alerts. - Indices & Navigation: Created docs/README.md navigation document, docs/sessions/README.md index, docs/adr/README.md index - Note: Also includes prior commit adding ADR-0200+ corpus hygiene governance (ADR-0225, dependency map, backfilled cross-references)
2.5 KiB
2.5 KiB
CORE Documentation Index
This is the central index for all documentation in the CORE project.
Canonical Root Documents
- Whitepaper.md - The CORE architectural and philosophical whitepaper.
- Yellowpaper.md - Technical specifications and mathematical formulation of the CORE engine.
- PROGRESS.md - High-level project progress tracking.
- specs/runtime_contracts.md - Critical invariants and bounds for the runtime execution flow.
Directories
Architecture & Design
- adr/ - Architecture Decision Records (ADRs). The canonical history of all ratified engineering choices.
- architecture/ - High-level architectural documents (e.g., pipelines, schemas).
- analysis/ - Deep dives and master plans for structural changes.
- specs/ - Detailed technical specifications and invariants.
Planning & Progress
- plans/ - Capability roadmaps and implementation plans.
- briefs/ - Project briefs and scoping documents for upcoming work.
- issues/ - Detailed issue analyses and technical reproductions (not standard trackers).
- audit/ - Audit reports and claims ledgers.
Operations & Usage
- examples/ - Usage examples and reference integrations.
- workbench/ - Documentation for the CORE workbench UI and related tooling.
- agents/ - Agent-specific operational guides.
Note regarding
agents/grok/: Operational guide for using Grok 4.3 + Grok Build with CORE. This is not architecture documentation.
Learning & Evaluation
- curriculum/ - Documentation on the teaching/learning order and knowledge progression.
- evals/ - Evaluation methodology and performance criteria documentation.
- benchmarks/ - Benchmark evidence and performance tracking logs.
Historical & Experimental
- sessions/ - Chronological session logs documenting the "decision trail" and intellectual history of major choices.
- handoffs/ - Handoff documents transferred between agent sessions.
- research/ - Raw research notes and preliminary findings.
- lab/ - Experimental content (Warning: Not ratified; must not be referenced as authoritative in production PRs).