| name | airjam-docs-workflow |
| description | Use when an Air Jam task needs canonical guidance and you need to know which local docs to read, when hosted docs are appropriate, and how to avoid reading the whole docs tree unnecessarily. |
Air Jam Docs Workflow
Use this skill when a task touches framework contracts, architecture, canonical patterns, or repo workflow rules.
Read First
docs/docs-index.md
- the smallest local docs page that matches the task
Default Rule
Use local docs first.
When a canonical docs contract changes, keep the derivative surfaces aligned in the same pass:
- source docs under
content/docs/
- generated scaffold docs under
packages/create-airjam/template-assets/base/docs/generated/
- repo-local skills under
packages/create-airjam/template-assets/base/skills/
- hosted AI pack files if they are generated from those sources
Use hosted Air Jam docs only when:
- the local docs pack does not cover the topic
- you need broader framework detail
- you need newer canonical public guidance
- the task is explicitly about syncing or updating docs
Local Docs Triggers
Read local docs when:
- creating a new gameplay system
- changing state ownership
- building controller UI
- changing rendering patterns
- updating tests or debug structure
- deciding where code should live
Anti-Patterns
- reading the entire docs tree for a small task
- skipping local docs and jumping straight to remote sources
- treating hosted docs as the only source of truth for a scaffolded project
- updating source docs but forgetting the generated scaffold/AI-pack surfaces