Skip to content

sentrix-labs/docs

Repository files navigation

Sentrix Chain Documentation Site

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

Local development

cd docs-site
npm install
npm start

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

Build

npm run build

Static site output to build/. Test served:

npm run serve

Content structure

Markdown source in docs/, mirrors the categorization from the original ../docs/ directory:

docs/
├── intro.md                    Welcome page (slug: /)
├── architecture/                CONSENSUS, EVM, STATE, etc.
├── operations/                  Quickstart, MetaMask, API endpoints, validator guide, monitoring
├── tokenomics/                  SRX, token standards, staking
├── security/                    Audits, pentest, attack vectors
├── roadmap/                     Phase 2/3, changelog
└── brand/                       Hero copy, one-pager, press boilerplate, social bios

When you add a new doc:

  1. Drop a markdown file under the appropriate category in docs/
  2. The autogenerated sidebar picks it up — no manual sidebar edit needed
  3. (Optional) Add front matter for sidebar position / custom slug:
---
sidebar_position: 1
title: Custom Title
slug: /custom-path
---

Deployment

Option A — Vercel (recommended, fastest)

  1. Push to GitHub (already on sentrix-labs/sentrix)
  2. Import project at https://vercel.com — point to docs-site/ subdirectory
  3. Build command: npm run build (default)
  4. Output directory: build (default)
  5. Set custom domain: docs.sentrixchain.com
  6. Configure DNS at Cloudflare: CNAME docs → cname.vercel-dns.com

Vercel auto-deploys on every push to main.

Option B — Cloudflare Pages

  1. Cloudflare dashboard → Pages → Connect to Git
  2. Repo: sentrix-labs/sentrix, root directory: docs-site
  3. Build command: npm run build
  4. Output: build
  5. Custom domain: docs.sentrixchain.com (auto-detected if domain is on Cloudflare)

Option C — GitHub Pages

GIT_USER=<your-username> npm run deploy

Configures GitHub Pages serving from gh-pages branch.

Brand

Maintenance

  • Source markdown files in docs/ are the source of truth for documentation
  • ../docs/ (top-level) holds operator-facing docs; for now, both the source dir and the docs-site copy are kept in sync manually
  • For Indonesian translation: add i18n/id/ directory + Docusaurus i18n config
  • For search: enable Algolia DocSearch (free for open-source) — apply at https://docsearch.algolia.com/apply

Source positioning

Master tokenomics + brand positioning: held in an internal brand-positioning doc (private repo).

About

Sentrix Chain documentation site (Docusaurus, served at docs.sentrixchain.com)

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors