docs: reorganize docs landscape
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)
This commit is contained in:
parent
63464144c5
commit
54e6bfc0d0
399 changed files with 694 additions and 1066 deletions
44
docs/README.md
Normal file
44
docs/README.md
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
# CORE Documentation Index
|
||||
|
||||
This is the central index for all documentation in the CORE project.
|
||||
|
||||
## Canonical Root Documents
|
||||
- [Whitepaper.md](../Whitepaper.md) - The CORE architectural and philosophical whitepaper.
|
||||
- [Yellowpaper.md](../Yellowpaper.md) - Technical specifications and mathematical formulation of the CORE engine.
|
||||
- [PROGRESS.md](../PROGRESS.md) - High-level project progress tracking.
|
||||
- [specs/runtime_contracts.md](specs/runtime_contracts.md) - Critical invariants and bounds for the runtime execution flow.
|
||||
|
||||
## Directories
|
||||
|
||||
### Architecture & Design
|
||||
- **[adr/](adr/)** - Architecture Decision Records (ADRs). The canonical history of all ratified engineering choices.
|
||||
- **[architecture/](architecture/)** - High-level architectural documents (e.g., pipelines, schemas).
|
||||
- **[analysis/](analysis/)** - Deep dives and master plans for structural changes.
|
||||
- **[specs/](specs/)** - Detailed technical specifications and invariants.
|
||||
|
||||
### Planning & Progress
|
||||
- **[plans/](plans/)** - Capability roadmaps and implementation plans.
|
||||
- **[briefs/](briefs/)** - Project briefs and scoping documents for upcoming work.
|
||||
- **[issues/](issues/)** - Detailed issue analyses and technical reproductions (not standard trackers).
|
||||
- **[audit/](audit/)** - Audit reports and claims ledgers.
|
||||
|
||||
### Operations & Usage
|
||||
- **[examples/](examples/)** - Usage examples and reference integrations.
|
||||
- **[workbench/](workbench/)** - Documentation for the CORE workbench UI and related tooling.
|
||||
- **[agents/](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/](curriculum/)** - Documentation on the teaching/learning order and knowledge progression.
|
||||
- **[evals/](evals/)** - Evaluation methodology and performance criteria documentation.
|
||||
- **[benchmarks/](benchmarks/)** - Benchmark evidence and performance tracking logs.
|
||||
|
||||
### Historical & Experimental
|
||||
- **[sessions/](sessions/)** - Chronological session logs documenting the "decision trail" and intellectual history of major choices.
|
||||
- **[handoffs/](handoffs/)** - Handoff documents transferred between agent sessions.
|
||||
- **[research/](research/)** - Raw research notes and preliminary findings.
|
||||
- **[lab/](lab/)** - Experimental content (Warning: Not ratified; must not be referenced as authoritative in production PRs).
|
||||
|
||||
### External
|
||||
- **[outreach/](outreach/)** - External communications and messaging.
|
||||
- **[zig/](zig/)** - Scoped documentation for the Zig language components.
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue