epoch_forge/docs/README.md

1.0 KiB

Epoch Forge documentation

This documentation describes current executable behavior and labels planned behavior clearly.

  • Commands: verified CLI surface and examples.
  • Repository format: files, epochs, compatibility, backup, and recovery.
  • Reversing changes: checkpoints and recovery for every mutation.
  • Architecture: crate responsibilities, data flow, and quality gates.
  • Staging design: approved Phase 4 state, command, transaction, and migration contract.
  • TUI design: approved first-pass scope, interaction, safety, and accessibility contract.
  • Simulation and world generation: seeded fuzzing, roads, movement, diffusion, map rendering, and config packaging.
  • Roadmap: current work and stretch proposals.

Start with the project README. Contributors should also read AGENTS.md and maintain AGENTS-TASKS.md.