Contributing

MoneroBox is a community project. Each page is a Markdown file under docs/, so fixes are easy to write and review.

Guidelines

1. No trusted shortcuts. Download from the official source, then verify the signature and the checksum. No curl | bash.
2. Explain the why. Every command block needs a sentence saying what it does.
3. Least privilege. Each service runs as its own system user, binds to 127.0.0.1 unless it must be reachable, and gets a firewall rule only when it needs one.
4. Pin versions. Put the version in a VERSION= shell variable at the top of each install section, so bumping a release changes one line.
5. Rate bonus guides. Add difficulty and "tested" badges at the top (see Rating).

Run the site locally

python3 -m venv .venv
.venv/bin/pip install -r requirements.txt
.venv/bin/mkdocs serve

Then open http://127.0.0.1:8000. Run .venv/bin/mkdocs build --strict before sending a change; it fails on broken internal links.

Release checklist

When a new Monero, P2Pool or XMRig version ships:

• [ ] Update the VERSION= line in the matching install and update sections
• [ ] Re-check flags and config options against the release notes
• [ ] Update the "Tested" badge on bonus guides you re-tested