Skip to main content

Writing ReddCoin Documentation

ReddCoin documentation is spread across a few places, each with a different audience and contribution flow.

This site (docs.reddcoin.com)​

You're looking at it. The site is open source at reddcoin-project/reddcoin-docs; every page has an "Edit this page" link in the footer that takes you straight to the source on GitHub.

Quick path:

  1. Click Edit this page at the bottom of the page you want to change.
  2. GitHub will offer to fork the repo if you don't already have a fork — accept.
  3. Make your edit in the GitHub web editor; click Preview to review.
  4. Fill in the Propose changes form at the bottom and submit a pull request.

For larger changes — restructuring a section, adding a whole new guide, swapping an illustration — clone the repository locally instead. The repo's README.md covers npm run start for a live preview and npm run build for the production check.

ReddCoin Core (in-tree docs)​

Documentation that lives next to the code — release notes, build instructions, architectural notes, JSON-RPC argument descriptions, contribution guidelines — is in the reddcoin-project/reddcoin repository, mostly under doc/ and in CONTRIBUTING.md. PRs against those files follow the regular Core contribution flow described in that repo's CONTRIBUTING.md.

When in-tree docs change in a way that affects user-facing behaviour (new RPCs, changed defaults, deprecations), the change should also land in this site's Protocol Reference — open a parallel PR against reddcoin-docs so both stay in sync.

Library READMEs and TSDoc​

Library API reference content (reddcoinjs-lib, the bitcore-*-redd packages) is generated from TSDoc comments and README files in each library's repository. Editing those is a code contribution, not a docs-site contribution — fix the source comment and the next sync will bring the change into this site automatically. See the Library API Reference for the current generated output.

Style and conventions​

A few rules to follow when writing for this site:

  • Brand spelling: ReddCoin (double-D) in user-visible text; lowercase reddcoin.com, reddcoind, reddcoin-cli, reddcoinjs-lib etc. for URLs, binaries, and package names.
  • Plain Markdown over MDX unless the page genuinely needs a React component (tabs, custom widgets, live code).
  • Use Docusaurus admonitions (:::note, :::warning, :::tip) rather than free-form HTML callouts.
  • Don't hand-edit anything under api/ — those files are regenerated by sync scripts and overwritten on next run.

The full contributor checklist lives in the repository's README.md.