Skip to main content

Documentation Standard

Every Rug Munch Media product ships documentation that meets this bar. If a product page is missing a section, that's a bug — file it.

The six required sections​

  1. Introduction — what it does, who it's for, honest status.
  2. Installation — from clone to running, with tested commands.
  3. Architecture — components, data flow, and what depends on what.
  4. API Reference — every endpoint/tool with request + response examples.
  5. Deployment — how we run it in production (Docker, nginx, systemd).
  6. Contributing — branch model, commit conventions, review gates.

Conventions​

  • Status banners: 🟢 Live · 🟡 Beta · 🔵 In development — never inferred, always explicit.
  • Commands are tested against the current release before publishing.
  • No methodology leaks: docs describe what the software does, never the internal detection heuristics, thresholds, or scoring weights. That is proprietary by design.
  • No internal infrastructure details: no hostnames, IPs, secret paths, or runbooks for our production fleet. Public docs use example.com placeholders.

Toolchain​

These docs are Docusaurus 3. Source: rugmunch-docs. PRs welcome — the edit link on every page opens the file in Forgejo.