# Documentation Index

This file is the canonical map of the `git-warp` documentation corpus.

Not every Markdown file in this repository is equally current. Use this index to
find the live docs first, then move into design history or archive material only
when you need that level of detail.

## Start Here

- [Root README](../README.md)
  Evaluator-facing overview: fit, architecture at a glance, and where to go next.
- [Getting Started](GETTING_STARTED.md)
  New-user tutorial: see the system work in a few minutes.
- [Guide](GUIDE.md)
  Builder guide: common app patterns with `WarpApp`, worldlines, observers, and strands.
- [API Reference](API_REFERENCE.md)
  Exhaustive API, appendices, flags, and examples without the narrative.
- [Advanced Guide](ADVANCED_GUIDE.md)
  Architect guide: substrate internals, replay, trust, and performance.
- [CLI Guide](CLI_GUIDE.md)
  Operator guide: inspect, validate, debug, and time-travel live repos.
- [Conceptual Overview](CONCEPTUAL_OVERVIEW.md)
  Deeper conceptual explanation of the WARP model and the Git substrate.

## Primary Product Docs

- [Getting Started](GETTING_STARTED.md)
  The first successful end-to-end path.
- [Guide](GUIDE.md)
  Day-to-day builder workflows.
- [API Reference](API_REFERENCE.md)
  Exhaustive surface for methods, flags, appendices, and errors.
- [Advanced Guide](ADVANCED_GUIDE.md)
  Advanced substrate and tooling topics.
- [Conceptual Overview](CONCEPTUAL_OVERVIEW.md)
  Background concepts and mental model for the Git-native WARP substrate.

## Operational And Normative Docs

- [Architecture](../ARCHITECTURE.md)
  System structure, public/core boundaries, and internal layering.
- [Release Guide](release.md)
  Release and preflight process.
- [Trust Migration](trust/TRUST_MIGRATION.md)
  Migration path for signed trust evidence.
- [Trust Operator Runbook](trust/TRUST_OPERATOR_RUNBOOK.md)
  Operational trust procedures.
- [Protocol Specs](specs/)
  Normative specs such as audit receipts, bisect, content attachment, and trust
  crypto.
- [ADR Registry](../adr/)
  Formal architectural decisions.

## Process And History

- [Design Notes](design/)
  Governing design docs for promoted backlog items and active cycles.
- [Retrospectives](retrospectives/)
  Slice close-out documents with design alignment audits.
- [Completed Roadmap](ROADMAP/COMPLETED.md)
  Archived milestone history.
- [Audits](audits/)
  Historical codebase audits retained for reference.
- [Checklists](checklists/)
  Focused release/readiness checklists kept as supporting records.

## Development Docs

- [Maintainer docs](../.github/maintainers/README.md)
  Contributor-facing process and documentation guidance for the repo.
- [Documentation style guide](../.github/maintainers/documentation/style-guide.md)
  Writing standard, audience model, and target information architecture for the
  docs corpus.

## Archive

- [Archive Index](archive/README.md)
  Superseded plans, transcripts, completed checklists, and other historical
  artifacts that should not be used as first-use docs.
