Contributing
Audience: Anyone submitting PRs, writing docs, or an AI agent working in this repo · Prereqs: None
Meta-documentation: how this documentation itself is organized and written, general contribution conventions, how to regenerate the reference tables, and how an AI agent should orient itself in this repo.
What's here
- Documentation style guide - the conventions every page in
wiki/docs/follows: the header block, voice, the AI-assistance disclaimer, filenames. Read this before adding or editing a page. - Generators - how the five generated reference pages work and how to regenerate them after a code change.
- For AI agents - orientation for an agent working in this repo: what's generated vs. hand-written, how to verify a claim against source, what not to trust.
- Conventions - general code style, the "could this be a plugin?" philosophy, when to touch core vs. write a plugin. (Not yet written.)
- Roadmap - the plan this whole documentation effort follows. (Not yet published here - currently lives as
DOCS_PLAN.mdat the repo root and will move into this section once the phases it describes are further along.)
This page was drafted with AI assistance and reviewed for accuracy. If something looks wrong, please open a PR or flag it.