Open the Docs →

docs.cryptorugmunch.com — single source of truth for every product

Every Rug Munch Media product ships with the same open-source documentation standard: Introduction, Installation, Architecture, API Reference, Deployment, Contributing. Written for engineers. Honest about what's shipped and what isn't. Always free.


Products with full docs


Infrastructure & tooling


What every product doc includes

Section What it covers
Introduction What the product is, the problem it solves, key features, current status (Live / Beta / In Development)
Installation Prerequisites, Quick Start (5 commands to hello-world), Docker, from-source, verification
Architecture System diagram, component map, data flow, external dependencies with rate limits
API Reference Every endpoint, auth model, rate limits, error codes, worked curl examples
Deployment Self-host guide, env vars, production checklist, backup/restore, upgrade path
Contributing Dev setup, code style, testing, PR process, security disclosure

Honesty standard. If a section isn’t ready, the doc says so explicitly. “This product is in development — see the repo for current build status.” Trust comes from not lying about what’s shipped.


Documentation standards

All product documentation follows the same open-source spec:

  • Docusaurus 3 as the framework (one tool to learn, one design language)
  • Black + neon-green theme matching the corporate brand
  • Rug Munch Media logo and link in every docs site nav and footer
  • Open-source under MIT (docs) and AGPL-3.0 / MIT (code)
  • Mirrored to Forgejo (primary), GitLab, Codeberg, and Radicle P2P
  • CI-gated with gitleaks, biome, and markdown link checking
  • OpenAPI-driven API reference where the source has typed schemas
  • Single source of truth at docs.cryptorugmunch.com/<product>

Contributing to docs

To contribute, fork the relevant product’s repository, edit the docs, and open a PR. Each product’s docs live in:

  • rugmunch-docs — the unified docs site at docs.cryptorugmunch.com
  • Or in the product repo’s /docs directory for product-specific deep-dives
git clone https://git.rugmunch.io/RugMunchMedia/rugmunch-docs.git
cd rugmunch-docs
pnpm install
pnpm start           # local preview at localhost:3000

# Make changes, commit, push
git checkout -b docs/<your-change>
git commit -m "docs(product): your change"
git push

Doc PRs go through the same CI gates as code PRs: gitleaks, biome, markdown link checking, and a docs preview deploy on every PR.


← Back to Home