Developing¶
Documentation for working on Lore, not with it.
What this folder is¶
Contributor and maintainer docs, organized by purpose. Four subfolders: internals/ for implementation-detail reference (byte layouts, struct formats, serialization specs), code-standards/ for coding conventions, doc-standards/ for the documentation house style, and decisions/ for architectural decision records.
Suggested starting points¶
- Writing a Lore doc? Start at
doc-standards/writing-a-doc.md. - Reviewing or self-validating a doc? Open
doc-standards/operational/review-checklist.md. - Looking for a coding convention? See
code-standards/. - Looking for a past architectural decision? See
decisions/. - Looking for implementation detail (byte layouts, internal protocols)? See
internals/.
See docs/README.md for the full docs structure.