Where Documentation Lives

Where the documentation lives

Wildbox has a lot of documentation in three places. This page says which one to open.

The website

wildbox.io is the published documentation and the right starting point for using the platform.

The repository root

Operational documents, kept next to the code they describe:

File	Answers
README.md	What it is, the architecture diagram, the component list, quick start
SETUP_GUIDE.md	Deployment, including production
TROUBLESHOOTING.md	Something is broken. The longest document in the repository and usually the fastest answer
SECURITY.md	The security policy and how to report a vulnerability privately
CONTRIBUTING.md	Development setup, service layout conventions
CHANGELOG.md	What changed and when

docs/

Two different kinds of document live here, which is worth knowing before you go looking.

User-facing, under subdirectories:

• docs/guides/ for credentials, deployment and operational guides
• docs/api/ for API documentation
• docs/guardian/ for the vulnerability service

Engineering and architecture, at the top level of docs/: architecture decisions and stack justification, engineering standards, testing strategy, service lifecycle, dependency management, observability roadmap, pre-commit hooks, secret rotation. These describe how the project is built rather than how it is used. Useful if you are contributing or evaluating the design, and mostly noise if you are trying to get a scan running.

There is also docs/llms.txt and docs/llms-full.txt, for AI assistants reading the project.

Per-service documentation

Each open-security-* directory carries its own README and, where relevant, its own docs. When a question is about one service, that is usually the shortest path.

What is not written down anywhere

The exact port and startup behaviour of each service, which is why the service map exists: it is read out of docker-compose.yml, which is the only authority on what actually starts.