Improve doc discovery

This commit is contained in:
Jared Miller 2026-02-11 21:46:51 -05:00
parent 7d4a75f973
commit 4ec09cffda
Signed by: shmup
GPG key ID: 22B5C6D66A38B06C
2 changed files with 4 additions and 1 deletions

View file

@ -27,6 +27,8 @@ Telnet MUD engine built on telnetlib3. Python 3.12+, managed with uv.
## Docs
Consult `docs/index.rst` when starting unfamiliar work to find relevant docs.
Three categories in `docs/`. Plain text or rst, not markdown.
- `docs/how/` - how things work. write one when you build something non-obvious.

View file

@ -133,7 +133,8 @@ portals:
depends on: phase 3 (portals and containers are Things)
enables: multi-zone world, interior spaces, locked doors, bags, keys
refs: object-model.rst (Container, Portal sections),
zones-and-building.rst (zone data format, hand-built zones)
zones-and-building.rst (zone data format, hand-built zones),
persistence.txt (what's persisted vs runtime — container contents not yet)
phase 5: verbs + interaction