Contributor Docs

Engineering notes for people working on Wildbox itself. They live in the repository under docs/ and are not published as pages of this site, so the links below go to GitHub. Several are working notes from earlier phases of the project; when one disagrees with the code, the code is right.

Start with CONTRIBUTING.md.

Engineering

• Engineering standards, referenced by SECURITY.md and the security validation script
• Architecture decision records
• Architecture stack evaluation
• Service lifecycle
• Testing strategy
• Dependency management
• Pre-commit hooks
• Error handling
• Observability roadmap

Security

• Gateway authentication pattern, referenced by SECURITY.md
• Secrets rotation
• Git history security audit

Documentation

• Documentation style guide

This site is the only documentation stack. GitHub Pages builds it from docs/ on main with Jekyll and the github-pages gem: Markdown pages are rendered through docs/_layouts/doc.html, the sidebar and sitemap come from docs/_data/docs_nav.yml, and docs/_config.yml decides what is published. The Docusaurus site that used to live in website/ has been removed from the repository; a website/ directory in a local checkout is a leftover and is ignored by git.

To add a page, write it under docs/guides/, docs/security/ or docs/api/ and add an entry to docs/_data/docs_nav.yml. CI runs markdownlint, cspell and a link check on every Markdown file.