{"id":50768813,"url":"https://github.com/reddcoin-project/reddcoin-docs","last_synced_at":"2026-06-11T16:30:48.177Z","repository":{"id":353739601,"uuid":"1220474886","full_name":"reddcoin-project/reddcoin-docs","owner":"reddcoin-project","description":"Documentation for ReddCoin — The Social Currency. Protocol reference, library APIs, operator guides.","archived":false,"fork":false,"pushed_at":"2026-04-25T08:51:36.000Z","size":2926,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-04-25T10:27:39.446Z","etag":null,"topics":["blockchain","cryptocurrency","documentation","posv","reddcoin"],"latest_commit_sha":null,"homepage":"https://docs.reddcoin.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reddcoin-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-25T00:05:54.000Z","updated_at":"2026-04-25T08:51:43.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/reddcoin-project/reddcoin-docs","commit_stats":null,"previous_names":["reddcoin-project/reddcoin-docs"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/reddcoin-project/reddcoin-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddcoin-project%2Freddcoin-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddcoin-project%2Freddcoin-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddcoin-project%2Freddcoin-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddcoin-project%2Freddcoin-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reddcoin-project","download_url":"https://codeload.github.com/reddcoin-project/reddcoin-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reddcoin-project%2Freddcoin-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34208761,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","cryptocurrency","documentation","posv","reddcoin"],"created_at":"2026-06-11T16:30:47.299Z","updated_at":"2026-06-11T16:30:48.163Z","avatar_url":"https://github.com/reddcoin-project.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReddCoin Docs\n\nThe unified ReddCoin documentation site. Aggregates content from the\nReddCoin source repositories — the protocol developer guide, the\n`reddcoinjs-lib` API, the bitcore library family, and user-facing\nguides — and ships a single site at\n**[docs.reddcoin.com](https://docs.reddcoin.com)**.\n\nBuilt with [Docusaurus 3](https://docusaurus.io) (TypeScript, classic\npreset).\n\n## Prerequisites\n\n- Node.js 20 or newer\n- npm 10 or newer\n\n## Quick start\n\n```bash\nnpm install\nnpm run start          # dev server on http://localhost:3000\n```\n\nThe dev server hot-reloads page content. Changes to\n`docusaurus.config.ts`, `sidebars/*.ts`, or new section directories\nrequire a restart.\n\n## Site structure\n\n```\ndocs/\n├─ protocol/      # blockchain + ReddCoin Core (dev guide, RPC, examples)\n├─ guides/        # user/operator guides (running a node, wallets, staking)\n├─ contribute/    # how to contribute to the ReddCoin project\n└─ glossary/      # terminology\napi/              # generated API reference, populated by sync scripts;\n                  # gitignored — do not hand-edit\nsidebars/         # per-section sidebar config\nsrc/              # React components, custom CSS, self-hosted fonts\nstatic/           # images, favicons, webmanifest\nscripts/          # deploy + sync scripts\n```\n\nEach section under `docs/` is wired as its own\n`@docusaurus/plugin-content-docs` instance with its own sidebar file,\nso they version, route, and navigate independently.\n\n## Commands\n\n| Command | What it does |\n| --- | --- |\n| `npm run start` | Dev server with hot reload |\n| `npm run build` | Production build into `build/` |\n| `npm run serve` | Preview the built site |\n| `npm run typecheck` | TypeScript checks on `docusaurus.config.ts` and sidebars |\n| `npm run deploy` | Build + rsync to the production Droplet (needs `scripts/deploy.env`) |\n\n## Contributing\n\nPRs are welcome. Before opening one:\n\n- **Capitalisation.** User-visible text spells the brand\n  **ReddCoin** (double-D, capital R, capital C). Internal strings —\n  repo names, directory paths, URLs, package names, code identifiers\n  — stay lowercase.\n- **Branding.** Logos, palette, and typography come from the ReddCoin\n  brand guide at [brand.reddcoin.com](https://brand.reddcoin.com).\n  Don't hand-edit logo SVGs or invent new colours; fix at the source\n  and update here.\n- **Pages.** New pages go in `docs/\u003csection\u003e/`. Use plain `.md`;\n  escalate to `.mdx` only when the page genuinely needs React\n  components (tabs, custom widgets, live code).\n- **Generated content.** Files under `api/` are regenerated by sync\n  scripts in `scripts/`. Don't hand-edit them; fix the upstream source\n  and re-run the sync.\n- **Build first.** `npm run build` and `npm run typecheck` must pass\n  before review.\n- **Commit messages.** Don't attribute commits to AI assistants.\n\n## Deployment\n\nThe site is a static build served from behind a CDN. The deploy\npipeline runs locally — there is no CI-driven deploy yet — and is\njust `npm run build` followed by an `rsync` of `build/` to the\nproduction web server. Both steps are wrapped by `npm run deploy`.\n\n### Who deploys\n\nMaintainers with deploy credentials. Connection details (host, path,\nSSH key) live in `scripts/deploy.env`, which is gitignored so the\nproduction endpoint stays out of the repo. To set up locally:\n\n```bash\ncp scripts/deploy.env.example scripts/deploy.env\n# edit scripts/deploy.env with the real values\n```\n\nReal values are shared out-of-band, not in this repo or in any PR.\n\n### When to deploy\n\nAfter a PR merges into `master`. Small content fixes can deploy\nimmediately. Larger reorganisations — new sections, sidebar\nrestructures, theme changes, generated-content syncs — should be\nsmoke-tested locally with `npm run build \u0026\u0026 npm run serve` before\nshipping.\n\n### Cache notes\n\nDocusaurus content-hashes JS, CSS, and font filenames, so each build\nships with fresh URLs and the CDN picks them up automatically.\n\nUnhashed assets at fixed paths — `/img/logo.svg`,\n`/img/favicon.ico`, `/site.webmanifest`, and anything else under\n`static/img/` — need a manual CDN cache purge after replacement, or\nthey stay stale until the CDN's TTL expires.\n\n### Rollback\n\n`git checkout` an earlier commit and re-run `npm run deploy`. The\noutput is fully static, so rollbacks are cheap and atomic — no\ndatabase migrations to reverse, no service restart, no downtime.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freddcoin-project%2Freddcoin-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freddcoin-project%2Freddcoin-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freddcoin-project%2Freddcoin-docs/lists"}