core/docs/README.md
Shay 0dbcd63d63 feat: 3lang depth PropGraph unification - phase refinements, wiring, tests + session pickup cleanups/governance
- Complete depth canonical, pack resolver DEPTH_PACKS, pipeline attrs+node_depths+graph_anti, contemplate/pass_manager/contracts propagation (immutable).
- Polish anti_unifier, tests (oov, construction, percent), runtime/chat integration.
- Governance: AGENTS.md updates, docs/README/handoff_template, skills bootstrap, retire handoff.
- Leaves pickup seeds (NEW_SESSION_PROMPT, plan.md, compact) for continuity.
- Spine tests green, 3lang depth visible in ctx for he.

Refs: plan.md, 2026-07-06-compact.md
2026-07-08 07:07:11 -07:00

44 lines
2.7 KiB
Markdown

# 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/)** - Legacy brief, audit, and investigation notes (historical; the formal HANDOFF mechanism is retired — see AGENTS.md for the current lightweight `session-break-summary-<DATETIME>.md` convention).
- **[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.