You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Docs: add a docs/ set mirroring Pithead (getting-started, configuration, operations, hardware, tuning, faq, integration) #25
RigForge ships only README.md + LICENSE. Mirror Pithead's docs/ set so the two read as one product (same structure, tone, and an index table). Pithead's set for reference: README (index), getting-started, hardware, configuration, dashboard, workers, architecture, operations, releasing, faq.
Proposed docs/ (miner-appropriate)
docs/README.md — index table linking the pages (mirrors Pithead's docs index).
docs/getting-started.md — fresh machine → tuned worker in one command: prerequisites, first run, the Linux reboot, verification.
docs/hardware.md — worker CPU/RAM/HugePages requirements + the per-CPU tuning profiles (lift from README, expand).
docs/ exists with the pages above, cross-linked from docs/README.md, matching Pithead's structure and tone.
README.md links out to docs/ instead of holding everything.
Note
Several pages depend on features still in flight — configuration.md/apply on #23, operations.md on #11 — so they can be stubbed and filled as those land. Happy to split this into per-page issues if preferred.
Scoping note (overnight pass): I held off on a PR here because a good docs/ set is a sizeable writing effort and I didn't want to drop 7 half-finished pages for review. Proposing the structure so you can greenlight the direction.
Proposed docs/ (mirroring Pithead), each page seeded from existing material:
Page
Seed from
docs/getting-started.md
README "Deployment" + "Connecting"
docs/configuration.md
config.json fields + worker-config template; pairs with the two-tier config work (#23)
docs/operations.md
README "Maintenance & logging" + "Verification"; will grow with the command surface (#11)
docs/hardware.md
README "Hardware Requirements"
docs/tuning.md
the CPU profiles (EPYC / Ryzen X3D / generic / macOS) + HugePages/MSR/GRUB
docs/integration.md
the new Worker API (Pithead integration) section just added in #34 — fold it in here
docs/faq.md
Secure Boot/MSR, reboot requirement, "no required XMRig version", etc.
Dependencies / sequencing: this reads best after the config refactor (#23) and command surface (#11) land, since configuration.md and operations.md document those interfaces — otherwise we'd write docs we immediately rewrite. I'd suggest doing #25 as a dedicated follow-up once #23/#11 are in (or at least decided).
If you'd rather I just start now with the structure above (lifting/expanding from the README), say the word in the morning and I'll open it. Leaving this open.
Activity
VijitSingh97 commentedon Jun 7, 2026
Scoping note (overnight pass): I held off on a PR here because a good
docs/set is a sizeable writing effort and I didn't want to drop 7 half-finished pages for review. Proposing the structure so you can greenlight the direction.Proposed
docs/(mirroring Pithead), each page seeded from existing material:docs/getting-started.mddocs/configuration.mdconfig.jsonfields +worker-configtemplate; pairs with the two-tier config work (#23)docs/operations.mddocs/hardware.mddocs/tuning.mddocs/integration.mddocs/faq.mdDependencies / sequencing: this reads best after the config refactor (#23) and command surface (#11) land, since
configuration.mdandoperations.mddocument those interfaces — otherwise we'd write docs we immediately rewrite. I'd suggest doing #25 as a dedicated follow-up once #23/#11 are in (or at least decided).If you'd rather I just start now with the structure above (lifting/expanding from the README), say the word in the morning and I'll open it. Leaving this open.
docs: fix pre-release accuracy issues found in audit (#40)