epoch_forge/docs/README.md

16 lines
774 B
Markdown

# Epoch Forge documentation
This documentation describes current executable behavior and labels planned
behavior clearly.
- [Commands](commands.md): verified CLI surface and examples.
- [Repository format](repository.md): files, epochs, compatibility, backup, and recovery.
- [Reversing changes](recovery.md): checkpoints and recovery for every mutation.
- [Architecture](architecture.md): crate responsibilities, data flow, and quality gates.
- [Staging design](staging-design.md): proposed Phase 4 state, command, transaction,
and migration contract.
- [Roadmap](roadmap.md): current work and stretch proposals.
Start with the project [README](../README.md). Contributors should also read
[AGENTS.md](../AGENTS.md) and maintain [AGENTS-TASKS.md](../AGENTS-TASKS.md).