Skip to content

Latest commit

 

History

History

README.md

Documentation

Central index for the do-not-stop monorepo. Cross-cutting docs live here; package-specific docs live next to their code and are linked below.

Start here

Cross-cutting docs

Doc What it is
Battle protocol The shipped backend-authoritative battle system. Part 1 plain words, Part 2 spec (§A–§M), Appendix A threat model, B operations runbook, C key-compromise runbook.
Future features roadmap Brainstorm for eleven unbuilt features. Not a build spec.
Inventory and item NFTs Execution order for roadmap §4, all four phases shipped. Records what was deployed to Base Sepolia and what the seeder still needs.
Battle + inventory hardening Review of §4 against the battle protocol, and the record of what it found and fixed. Read it before touching the snapshot, ruleset, or drop paths: several of its entries are corrections to claims other docs made.
Testing Per-package suite table and conventions.

Package docs

Area Doc
Backend API backend/API.md, backend/README.md
Go indexer services/indexer-go/README.md
Contract upgrade plan contracts/plan-contract-upgrade.md
gRPC contract proto/cryptopets.proto

Conventions

  • Keep package-specific docs in the package (its own README.md); link them from here rather than copying.
  • Put cross-cutting docs (architecture, testing, decisions that span packages) in this directory.
  • When a doc goes stale, fix or delete it — a wrong doc is worse than none.