| title | Documentation map | |||||
|---|---|---|---|---|---|---|
| kind | project | |||||
| audience |
|
|||||
| canonical_for |
|
|||||
| requires |
Every page below is registered in manifest.yml, owns at least one topic, and is
reachable from here. That is the whole of the arrangement; the rules behind it are in
Documentation contract.
Behaviour is specified separately, in Allium, under docs/specs/ — six modules rooted
at words.allium. Those files are not part of this handbook; they
are its subject. Start at Specifications to understand
how the two relate.
- Purpose and scope — what Poodl is for, and what it is not.
- Repository map — where everything lives.
- Terminology — the words this repository uses precisely.
- Make your first change — clone to green gate, once through every layer.
- Develop locally
- Test and debug
- Work in the component workshop
- Port a design system component
- Work with the specifications
- Replace the word lists
- Maintain dependencies
- Deploy to GitHub Pages
- Design direction — how Biscuit Games looks and feels, and why.
- Design resource index — research, standards, tools and public systems for mobile-web, game and component design.
- Architecture — how a static site with no server is put together.
- Layering and dependency direction — which module may import which.
- Specifications — why behaviour is written down before it is built.
- Accessibility — the obligations the specifications state.
- Security model — what a site with no backend does and does not defend.
- Quality philosophy — why each gate exists.
- Architecture decisions — the record of what was chosen and why.