https://github.com/reddcoin-project/reddcoin-docs
Documentation for ReddCoin — The Social Currency. Protocol reference, library APIs, operator guides.
https://github.com/reddcoin-project/reddcoin-docs
blockchain cryptocurrency documentation posv reddcoin
Last synced: 18 days ago
JSON representation
Documentation for ReddCoin — The Social Currency. Protocol reference, library APIs, operator guides.
- Host: GitHub
- URL: https://github.com/reddcoin-project/reddcoin-docs
- Owner: reddcoin-project
- License: other
- Created: 2026-04-25T00:05:54.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2026-04-25T08:51:36.000Z (2 months ago)
- Last Synced: 2026-04-25T10:27:39.446Z (2 months ago)
- Topics: blockchain, cryptocurrency, documentation, posv, reddcoin
- Language: JavaScript
- Homepage: https://docs.reddcoin.com
- Size: 2.79 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReddCoin Docs
The unified ReddCoin documentation site. Aggregates content from the
ReddCoin source repositories — the protocol developer guide, the
`reddcoinjs-lib` API, the bitcore library family, and user-facing
guides — and ships a single site at
**[docs.reddcoin.com](https://docs.reddcoin.com)**.
Built with [Docusaurus 3](https://docusaurus.io) (TypeScript, classic
preset).
## Prerequisites
- Node.js 20 or newer
- npm 10 or newer
## Quick start
```bash
npm install
npm run start # dev server on http://localhost:3000
```
The dev server hot-reloads page content. Changes to
`docusaurus.config.ts`, `sidebars/*.ts`, or new section directories
require a restart.
## Site structure
```
docs/
├─ protocol/ # blockchain + ReddCoin Core (dev guide, RPC, examples)
├─ guides/ # user/operator guides (running a node, wallets, staking)
├─ contribute/ # how to contribute to the ReddCoin project
└─ glossary/ # terminology
api/ # generated API reference, populated by sync scripts;
# gitignored — do not hand-edit
sidebars/ # per-section sidebar config
src/ # React components, custom CSS, self-hosted fonts
static/ # images, favicons, webmanifest
scripts/ # deploy + sync scripts
```
Each section under `docs/` is wired as its own
`@docusaurus/plugin-content-docs` instance with its own sidebar file,
so they version, route, and navigate independently.
## Commands
| Command | What it does |
| --- | --- |
| `npm run start` | Dev server with hot reload |
| `npm run build` | Production build into `build/` |
| `npm run serve` | Preview the built site |
| `npm run typecheck` | TypeScript checks on `docusaurus.config.ts` and sidebars |
| `npm run deploy` | Build + rsync to the production Droplet (needs `scripts/deploy.env`) |
## Contributing
PRs are welcome. Before opening one:
- **Capitalisation.** User-visible text spells the brand
**ReddCoin** (double-D, capital R, capital C). Internal strings —
repo names, directory paths, URLs, package names, code identifiers
— stay lowercase.
- **Branding.** Logos, palette, and typography come from the ReddCoin
brand guide at [brand.reddcoin.com](https://brand.reddcoin.com).
Don't hand-edit logo SVGs or invent new colours; fix at the source
and update here.
- **Pages.** New pages go in `docs//`. Use plain `.md`;
escalate to `.mdx` only when the page genuinely needs React
components (tabs, custom widgets, live code).
- **Generated content.** Files under `api/` are regenerated by sync
scripts in `scripts/`. Don't hand-edit them; fix the upstream source
and re-run the sync.
- **Build first.** `npm run build` and `npm run typecheck` must pass
before review.
- **Commit messages.** Don't attribute commits to AI assistants.
## Deployment
The site is a static build served from behind a CDN. The deploy
pipeline runs locally — there is no CI-driven deploy yet — and is
just `npm run build` followed by an `rsync` of `build/` to the
production web server. Both steps are wrapped by `npm run deploy`.
### Who deploys
Maintainers with deploy credentials. Connection details (host, path,
SSH key) live in `scripts/deploy.env`, which is gitignored so the
production endpoint stays out of the repo. To set up locally:
```bash
cp scripts/deploy.env.example scripts/deploy.env
# edit scripts/deploy.env with the real values
```
Real values are shared out-of-band, not in this repo or in any PR.
### When to deploy
After a PR merges into `master`. Small content fixes can deploy
immediately. Larger reorganisations — new sections, sidebar
restructures, theme changes, generated-content syncs — should be
smoke-tested locally with `npm run build && npm run serve` before
shipping.
### Cache notes
Docusaurus content-hashes JS, CSS, and font filenames, so each build
ships with fresh URLs and the CDN picks them up automatically.
Unhashed assets at fixed paths — `/img/logo.svg`,
`/img/favicon.ico`, `/site.webmanifest`, and anything else under
`static/img/` — need a manual CDN cache purge after replacement, or
they stay stale until the CDN's TTL expires.
### Rollback
`git checkout` an earlier commit and re-run `npm run deploy`. The
output is fully static, so rollbacks are cheap and atomic — no
database migrations to reverse, no service restart, no downtime.