Skip to content
Tamperboxtamper[box] docs

Contributing

Improve the public Tamperbox documentation with focused changes and verifiable product claims.

Open Markdown

Local setup

Section titled “Local setup”
Terminal window
git clone https://github.com/oceanrescue/tamperbox-doc.git
cd tamperbox-doc
npm ci
npm run dev

Content contract

Section titled “Content contract”

Every page includes a review date, product version, agent summary, prerequisites, outputs, and limitations. These fields support the visible docs and the generated agent resources.

Add user-facing pages under src/content/docs. Update astro.config.mjs when the page belongs in the primary sidebar.

Verify changes

Section titled “Verify changes”
Terminal window
npm run check
npm run build

The static build must include the human-readable page, its .md mirror, llms.txt, llms-full.txt, and the sitemap.

Claim discipline

Section titled “Claim discipline”

Check product claims against the Tamperbox MCP repository, its bundled OpenAPI document, and current release records. Separate implemented behavior from proposals and future work.