Skip to content

Docs: add a docs/ set mirroring Pithead (getting-started, configuration, operations, hardware, tuning, faq, integration) #25

Closed

Description

@VijitSingh97

Goal

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)

Already tracked — don't duplicate

Acceptance

  • 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.

Activity

  1. added this to the v1.0 milestone on Jun 6, 2026
  2. VijitSingh97 commented on Jun 7, 2026

    @VijitSingh97
    ContributorAuthor

    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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions