Skip to content

sentinel-official/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

668 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sentinel

Sentinel Docs

The official documentation portal for the Sentinel ecosystem.

Read the docs »

Report a bug · Request a feature


About Sentinel Docs

Sentinel is a layer-one peer-to-peer bandwidth marketplace DePIN blockchain that powers decentralized VPNs (dVPNs) and training data acquisition for AI models. Built on the Cosmos SDK, it lets anyone host a node and sell bandwidth to real-world users worldwide.

This repository holds the source for docs.sentinel.co, the canonical documentation site for the Sentinel ecosystem. It is built with Docusaurus 3 and covers everything from end-user onboarding to node operations, validator setup, and SDK integration.

The docs are written for end users picking a dVPN app, $P2P holders looking at the token economy, node operators and validators running infrastructure, and developers integrating Sentinel through the SDKs and APIs.

What's inside

The site is organized by audience. Each entry below links to that section's source folder.

For everyone

  • Get Started  ·  introduction, glossary, governance, whitepaper, wallets, dVPN apps.
  • $P2P Coin  ·  token economics, buying, earning, staking.

For developers and integrators (Sentinel Core)

  • Sentinel Hub  ·  chain build instructions and CLI command reference.
  • Sentinel dVPN CLI  ·  dVPN command-line interface.
  • SDKs  ·  official (Go, JavaScript, Python), community (.NET, blue-js), and agent automation (AI Connect, Plan Manager, x402).
  • Networks  ·  chain registry, asset info, endpoints, explorers.

For node operators

  • dVPN Nodes  ·  bandwidth provider setup, earnings, health checks, and tools.
  • Full Nodes  ·  server prep, hub setup and config, install and run, Docker, public RPC/API, IBC relayers, validator tooling, upgrades.
  • Node Monitoring  ·  Grafana, Prometheus, Loki, exporters, alerting bots.

API reference

  • APIs  ·  REST, RPC, and gRPC reference rendered with Stoplight Elements.

Read it locally

You can run the entire site on your machine with hot reload.

Prerequisites: Node.js 20+ and npm.

git clone https://github.com/sentinel-official/docs.git
cd docs
npm install
npm start

The dev server starts on http://localhost:3000. Edits to any markdown or component file reload automatically.

Available scripts

Command What it does
npm start Start the local dev server with hot reload.
npm run build Generate the static production build into build/.
npm run serve Serve the production build locally.
npm run clear Clear the Docusaurus cache.
npm run lint Run ESLint with auto-fix.
npm run lint:fix Same as lint with explicit --fix.
npm test Run the Jest test suite.
npm run swizzle Eject and customize a Docusaurus theme component.
npm run deploy Publish the built site to GitHub Pages.
npm run write-translations Extract translatable strings.
npm run write-heading-ids Generate stable heading IDs across MDX/MD files.

Built with

Project layout

docs/                          Markdown content, one folder per section.
src/                           React components, theme overrides, custom pages, sections.js.
static/                        Images, logos, fonts, social cards.
plugins/                       Custom Docusaurus webpack plugin.
sidebars-default.js            Default sidebar config used by most sections.
sidebars-home.js               Homepage sidebar.
sidebars-full-node-setup.js    Dedicated sidebar for the full-node guide.
docusaurus.config.js           Site config; sections registered via `defineSection()`.

License

Distributed under the Apache License, Version 2.0. See LICENSE for details.

Find Sentinel


© Sentinel P2P. Built and maintained by Trinity Stake.

About

Documentation for all Sentinel network tools, services, and components

Resources

License

Stars

Watchers

Forks

Contributors