Maintaining this documentation site
The site is published on GitHub Pages. Its pages are generated from the repository's existing documentation and skill usage examples. No browser framework or runtime service is required.
Build locally
From the repository root, use Python 3.10 or later:
python3 -m venv .venv-docs
.venv-docs/bin/python -m pip install -r requirements-docs.txt
.venv-docs/bin/python scripts/build-docs.py
.venv-docs/bin/python scripts/check-docs.py
python3 -m http.server 8000 --directory dist
Open http://localhost:8000. The build creates dist/, which is ignored by Git.
Update content
- Edit
docs/skills/<skill>.mdto update a skill's in-depth page (when to use it, inputs, workflow, boundaries, and example prompts). When this file exists, the builder publishes it as the skill page and adds the invocation note and a link to the skill'sSKILL.md. - Edit
docs/usage.mdto update the complete usage guide. For a skill without adocs/skills/guide, the builder extracts its section from this file instead. - Edit
README.mdto update installation instructions. The builder extracts its installation section. - Edit
site/index.mdfor home content,site/home-template.htmlfor its layout, andsite/assets/home.cssfor home styles. The guide pages usesite/template.html. - Update the page list in
scripts/build-docs.pywhen adding a guide. Add new skills to the usage guide and the builder's skill list together. - Keep commands grounded in actual host and installer behavior. Discovery checks do not prove interactive invocation.
The builder checks that every packaged skill has a usage page. The link checker checks all generated internal page, asset, and fragment links. Source links lead back to GitHub; repository-relative links that are not published pages also lead to GitHub.
Reader appearance
The header's Dark mode toggle switches between light and dark appearance. The first visit follows the browser's system color preference; a manual choice is stored locally and reused across guides and reloads. Until a manual choice is made, system preference changes update the current page. If browser storage is unavailable, the toggle still works for the current page.
Theme colors live in site/assets/style.css. site/assets/theme.js applies the
initial preference before the stylesheet loads and connects the accessible toggle.
Print styles use a light background in either mode.
Publish
The .github/workflows/docs.yml workflow builds and checks the site on pull requests. Pushes to dev that change site inputs also deploy to the github-pages environment. It can be run manually from GitHub Actions.
Repository Settings → Pages must use GitHub Actions as the source. Deployment follows the GitHub Pages custom workflow model.
Content evidence
| Published content | Repository evidence |
|---|---|
| Installation commands and limitations | README.md, scripts/install-skills.py, plugin manifests |
| Skill prompts, inputs, expected results, boundaries | docs/skills/*.md, docs/usage.md, each skills/*/SKILL.md |
| Version and skill inventory | plugin.json, packaged skills/ directories |
| Routing and handoff | docs/routing.md, docs/skill-contract.md |
| Historical check results and limitations | docs/verification.md, linked repository reports |
| Attribution and licensing | SOURCE_NOTICES.md, upstream-lock.json |
The site build and link check verify the generated documentation. They do not execute the example agent prompts or repeat the historical skill evaluations.