Development¶
Repository Layout¶
agents/ Markdown agent prompts
skills/ Skill directories; each has a SKILL.md
catalog/ Generated router artifacts
scripts/ Router, hook installer, validation, and benchmark scripts
tests/ Unit tests and routing benchmark cases
docs/ MkDocs source files
Add or Edit a Skill¶
- Create or edit
skills/<skill-name>/SKILL.md. - Keep the YAML
namefield identical to the directory name. - Put long tool notes, examples, and references in subdirectories rather than crowding
SKILL.md. - Update the relevant agent file:
Mandatory Skill UsageWorkflow Decision TreeTask Recognition Patterns- Rebuild the catalog.
- Add routing benchmark coverage when the skill should be discoverable from natural language.
Commands:
python3 scripts/skill_index.py build
python3 scripts/validate-skills.py
python3 scripts/validate-supplementary-docs.py
python3 -m unittest discover -s tests -v
make benchmark
Documentation Style¶
Keep documentation concrete:
- Say what a skill is for, what it expects, and what it produces.
- Prefer short examples over abstract descriptions.
- Record exact tool versions, database names, URLs, and commands when a result needs to be reproducible.
- For supplementary tool/source guides, include
Last verified,Tool version/release checked,Official docs/manual, andRelease/sourcelines near the top. - Keep
SKILL.mdfocused; move detailed tool notes intodocs/,references/,examples/, orsummaries/inside the skill directory.
Work on the MkDocs Site¶
Preview locally:
Build strictly:
The GitHub Pages workflow runs the same strict build before deployment.
Validation Checklist¶
Before opening a pull request:
python3 scripts/validate-skills.py
python3 scripts/validate-supplementary-docs.py
python3 -m unittest discover -s tests -v
make benchmark
uvx --from mkdocs --with 'mkdocs-material==9.5.*' --with pymdown-extensions mkdocs build --strict
If routing behavior changes, update tests/routing_benchmark.yaml and refresh docs/routing_baseline.json only after reviewing the benchmark delta.
For contribution workflow details, see Contributing. Distribution and marketplace notes live in Distribution.