project-layout
Installation
SKILL.md
Project Layout
Treat all paths as relative to the project root, normally the Git worktree root. Use this layout for new work; do not introduce alternative paths.
| Path | Purpose |
|---|---|
docs/ |
Maintained project documentation and knowledge. |
docs/wiki/ |
Interlinked or LLM-maintained knowledge base. |
docs/public/ |
Portable publication output. |
plans/to-do/ |
Draft or queued work. |
plans/in-progress/ |
Active work that must survive across sessions. |
plans/completed/ |
Finished plans retained as history. |
plans/notes/ |
Exploratory notes, notebooks, and long-term guidance. |
ref/ |
Immutable external sources and reference inputs. |
ref/inbox/ |
The one mutable lane under ref/: staging for sources awaiting placement. Files become immutable once moved into ref/. |
Keep tool-required files such as README.md, AGENTS.md, CLAUDE.md, LICENSE, and ecosystem configuration at the root.
Source paths such as src/, tests/, package assets, repository utilities, and files inside an installed skill follow their own ecosystem conventions.