Sentrix Chain Documentation Site

Source for docs.sentrixchain.com — built with Docusaurus 3.

This repo holds the markdown content + Docusaurus configuration. Pushes to main trigger an auto-deploy to the self-hosted origin behind Cloudflare.

Repo structure

.
├── docs/                       Markdown source (one file per page)
│   ├── intro.md                Welcome / landing page (slug: /)
│   ├── architecture/           Consensus, EVM, state, networking, transactions
│   ├── operations/             Validator guide, MetaMask, API/gRPC/WSS, integration cookbook
│   ├── tokenomics/             SRX, staking, token standards, reward escrow
│   ├── security/               Audits, attack vectors, multisig, pentest
│   ├── roadmap/                Phase docs + CHANGELOG
│   ├── debugging/              In-depth recovery + diagnosis notes
│   └── assets/                 Images referenced from markdown
├── src/                        Custom React components / theming overrides
├── static/                     Static files served at site root (favicon, robots.txt)
├── docusaurus.config.ts        Site config (title, URL, plugins, theme)
├── sidebars.ts                 Sidebar layout (or autogenerated if absent)
├── package.json                Docusaurus + plugins pinned versions
└── .github/workflows/deploy.yml   Auto-deploy on push to main

Local development

git clone git@github.com:sentrix-labs/docs.git
cd docs
npm install
npm start

Opens dev server at http://localhost:3000. Hot-reloads on every markdown save.

Production build

npm run build       # outputs static site to ./build/
npm run serve       # serves ./build/ locally for verification

Adding or editing content

1. Drop or edit a markdown file under the appropriate directory in docs/.

2. The autogenerated sidebar picks it up — no manual sidebars.ts edit usually needed.

3. (Optional) Front matter for custom slug / position:

   ---
   sidebar_position: 2
   title: Custom Title
   slug: /custom-path
   ---

4. Open a PR. Merge to main triggers the auto-deploy below.

Auto-deploy

Pushes to main that modify any of docs/, static/, src/, docusaurus.config.ts, sidebars.ts, package.json, or the workflow file itself trigger .github/workflows/deploy.yml. The action:

1. SSHs into the self-hosted origin using an ed25519 deploy key.
2. Origin host's authorized_keys pins the key to a forced-command pointing at ~/docs/scripts/deploy.sh.
3. deploy.sh runs: git reset --hard origin/main → npm ci → npm run build → rsync build/ → /var/www/docs-sentrixchain/.
4. Caddy serves the new content immediately (no restart needed — static files).

End-to-end latency: ~2 minutes from merge to live.

Deploy logs persist on the origin host at ~/.docs-deploy-logs/<timestamp>.log. Concurrency is serialised under the docs-deploy group, so overlapping merges queue instead of racing the rsync.

Required repo secrets (one-time setup)

Secret	Purpose
DEPLOY_HOST	Public hostname / IP of the origin
DEPLOY_USER	SSH login on the origin (matches the authorized_keys entry)
DEPLOY_KEY	ed25519 private key (multi-line, includes -----BEGIN/END OPENSSH PRIVATE KEY----- lines)
DEPLOY_PORT	(optional) non-default SSH port

Manual trigger

If you need to re-deploy without a content change (e.g. after fixing a misconfigured DNS):

gh workflow run deploy.yml --repo sentrix-labs/docs --ref main

Brand

• Tagline: "Open source EVM L1 in Rust."
• Logo source: sentrix-labs/brand-kit
• Positioning canon: see internal brand reference (private repo).

Maintenance

• The markdown in docs/ is the single source of truth for docs.sentrixchain.com. The chain code repo (sentrix-labs/sentrix) used to mirror a copy under its own docs/ directory; that mirror was retired on 2026-05-28 (PR sentrix-labs/sentrix#737).
• Docusaurus version bumps: run npm install @docusaurus/core@latest … per the upstream upgrade notes, test locally with npm run start + npm run build, ship as its own PR (so a regression is easy to bisect).
• Indonesian translation: would land under i18n/id/ plus a i18n block in docusaurus.config.ts. Not started yet.
• Search: Algolia DocSearch is free for open-source projects — apply at docsearch.algolia.com/apply.

Where things live

Topic	URL
Rendered docs	https://docs.sentrixchain.com
Chain code	https://github.com/sentrix-labs/sentrix
Awesome list	https://github.com/sentrix-labs/awesome-sentrix
Improvement proposals	https://github.com/sentrix-labs/SIPs
Brand assets	https://github.com/sentrix-labs/brand-kit