Skip to content

DOCUMENT_MAP.md

Latest commit

 

History

History
140 lines (117 loc) · 16.9 KB

DOCUMENT_MAP.md

File metadata and controls

140 lines (117 loc) · 16.9 KB
Raw

Document Map

Document dependency graph, reading order recommendations, and status tracking for the B.Y.T.E. documentation set. Audience: Everyone Status: Complete

Document Dependency Graph

START_HERE.md (entry point)
├──→ CONCEPTUAL_OVERVIEW.md (plain-language)
│   └──→ REFERENCE.md (glossary)
├──→ README.md (project overview)
│   └──→ PHASES.md (canonical build phase status)
└──→ TECHNICAL_CONCEPT.md (core specification, Sections 1–18)
    ├──→ core/GRAPH.md (world-state graph)
    ├──→ core/RPU.md (reasoning coprocessor)
    ├──→ core/ORCHESTRATION.md (execution primitives)
    ├──→ core/MACROS.md (macro system)
    ├──→ core/REGISTRY.md (code registry)
    ├──→ core/ENTITIES.md (entity model, store strategy)
    ├──→ core/CHANNELS.md (channel architecture)
    ├──→ core/RETRIEVAL.md (retrieval pipeline)
    ├──→ core/EDGE_ARCHITECTURE.md (edge node)
    ├──→ core/MULTIMODAL_INTERFACE.md (multimodal input)
    ├──→ core/OFFLINE_OPTIMIZATION.md (background loop)
    ├──→ core/SECURITY.md (security & privacy)
    ├──→ core/EVALUATION.md (evaluation methodology)
    ├──→ core/KNOWN_GAPS.md (open problems)
    ├──→ core/DESIGN_DECISIONS.md (rationale)
    ├──→ core/THREAT_MODEL.md (threat analysis)
    └──→ core/ARCHITECTURE_DIAGRAMS.md (flow diagrams)

Reading Order by Audience

Non-Technical Readers

  1. START_HERE.md — orientation and system overview
  2. CONCEPTUAL_OVERVIEW.md — plain-language explanation
  3. REFERENCE.md — keep open as reference for terms

Technical Readers (First Pass)

  1. START_HERE.md — orientation
  2. README.md — project abstract and navigation
  3. REFERENCE.md — terminology (keep open)
  4. TECHNICAL_CONCEPT.md — core specification (Sections 1–18)
  5. core/DESIGN_DECISIONS.md — rationale behind choices

Technical Readers (Deep Dive)

After first pass, read core documents as needed:

Researchers

  1. TECHNICAL_CONCEPT.md Sections 1–4 (thesis and foundation)
  2. core/EVALUATION.md — methodology, baselines, ablation
  3. core/KNOWN_GAPS.md — open problems
  4. core/DESIGN_DECISIONS.md — rationale

Security Reviewers

  1. core/SECURITY.md — security specification
  2. core/THREAT_MODEL.md — threat scenarios and mitigations
  3. TECHNICAL_CONCEPT.md (invariants), TECHNICAL_CONCEPT.md (security)

Document Status

Document Status Audience
START_HERE.md Complete Everyone
README.md Complete Everyone
PHASES.md Active Everyone
CONCEPTUAL_OVERVIEW.md Complete Everyone
REFERENCE.md Complete Everyone
DOCUMENT_MAP.md Complete Everyone
TECHNICAL_CONCEPT.md Complete Technical
core/GRAPH.md Complete Technical
core/RPU.md Complete Technical
core/ORCHESTRATION.md Complete Technical
core/MACROS.md Complete Technical
core/REGISTRY.md Complete Technical
core/ENTITIES.md Complete Technical
core/CHANNELS.md Complete Technical
core/RETRIEVAL.md Complete Technical
core/EDGE_ARCHITECTURE.md Complete Technical
core/MULTIMODAL_INTERFACE.md Complete Technical
core/OFFLINE_OPTIMIZATION.md Complete Technical
core/SECURITY.md Complete Technical
core/EVALUATION.md Complete Technical / Research
core/KNOWN_GAPS.md Complete Technical / Research
core/DESIGN_DECISIONS.md Complete Technical
core/THREAT_MODEL.md Complete Technical / Security
core/ARCHITECTURE_DIAGRAMS.md Complete Technical

Cross-Reference Index

Referenced By References
TECHNICAL_CONCEPT.md core/GRAPH.md, core/RPU.md, core/ORCHESTRATION.md, core/MACROS.md, core/REGISTRY.md, core/ENTITIES.md, core/CHANNELS.md, core/RETRIEVAL.md, core/EDGE_ARCHITECTURE.md, core/MULTIMODAL_INTERFACE.md, core/OFFLINE_OPTIMIZATION.md, core/SECURITY.md, core/EVALUATION.md, core/KNOWN_GAPS.md, core/DESIGN_DECISIONS.md, core/THREAT_MODEL.md, core/ARCHITECTURE_DIAGRAMS.md
README.md START_HERE.md, CONCEPTUAL_OVERVIEW.md, REFERENCE.md, TECHNICAL_CONCEPT.md, PHASES.md, all core documents
START_HERE.md CONCEPTUAL_OVERVIEW.md, README.md, REFERENCE.md, TECHNICAL_CONCEPT.md, PHASES.md
PHASES.md TECHNICAL_CONCEPT.md, core/GRAPH.md, core/RPU.md, core/ORCHESTRATION.md, core/MACROS.md, core/REGISTRY.md, core/EDGE_ARCHITECTURE.md, core/MULTIMODAL_INTERFACE.md, core/EVALUATION.md
CONTRIBUTING.md core/KNOWN_GAPS.md, core/DESIGN_DECISIONS.md, core/EVALUATION.md, DOCUMENT_MAP.md
REVIEW.md All documents (analysis of full documentation set)
DOCUMENT_MAP.md All documents (dependency tracking and status)
CONCEPTUAL_OVERVIEW.md TECHNICAL_CONCEPT.md, core/EVALUATION.md, core/KNOWN_GAPS.md, REFERENCE.md, PHASES.md
core/RPU.md TECHNICAL_CONCEPT.md, core/ORCHESTRATION.md, core/MACROS.md
core/ORCHESTRATION.md TECHNICAL_CONCEPT.md, core/MACROS.md, core/REGISTRY.md
core/MACROS.md TECHNICAL_CONCEPT.md, core/ORCHESTRATION.md, core/RPU.md, core/SECURITY.md (skill-derived validation)
core/REGISTRY.md TECHNICAL_CONCEPT.md, core/ORCHESTRATION.md
core/ENTITIES.md TECHNICAL_CONCEPT.md, core/CHANNELS.md, core/RETRIEVAL.md, core/GRAPH.md
core/CHANNELS.md TECHNICAL_CONCEPT.md, core/ENTITIES.md, core/RETRIEVAL.md
core/RETRIEVAL.md TECHNICAL_CONCEPT.md, core/ENTITIES.md, core/CHANNELS.md, core/RPU.md
core/EDGE_ARCHITECTURE.md TECHNICAL_CONCEPT.md
core/MULTIMODAL_INTERFACE.md TECHNICAL_CONCEPT.md
core/OFFLINE_OPTIMIZATION.md TECHNICAL_CONCEPT.md, core/EVALUATION.md
core/SECURITY.md TECHNICAL_CONCEPT.md, core/THREAT_MODEL.md
core/THREAT_MODEL.md core/SECURITY.md, TECHNICAL_CONCEPT.md, core/GRAPH.md (trust hierarchy reference)
core/EVALUATION.md TECHNICAL_CONCEPT.md, core/KNOWN_GAPS.md
core/KNOWN_GAPS.md TECHNICAL_CONCEPT.md, core/EVALUATION.md, core/DESIGN_DECISIONS.md
core/DESIGN_DECISIONS.md TECHNICAL_CONCEPT.md, core/KNOWN_GAPS.md
core/GRAPH.md TECHNICAL_CONCEPT.md, core/ARCHITECTURE_DIAGRAMS.md
core/ARCHITECTURE_DIAGRAMS.md TECHNICAL_CONCEPT.md, core/GRAPH.md, core/ENTITIES.md, core/EDGE_ARCHITECTURE.md
REFERENCE.md All documents (terminology reference)