Welcome to the Helios Documentation Repository, the official knowledge hub for the Helios Blockchain. This repository contains developer guides, staking instructions, governance protocols, and interchain mechanics built using Docusaurus.
- Built with Docusaurus – A modern static site generator for efficient documentation.
- Fully Open-Source – Contributions from the Helios community are welcome.
- Comprehensive Guides – Covers everything from validator setup to governance voting.
- Interchain Proof of Stake and Reputation (I-PoSR) – Learn how Helios unifies decentralized networks.
- Live Updates & Versioning – Ensures up-to-date blockchain documentation.
To set up the documentation locally, clone the repository and install dependencies:
$ git clone https://github.com/helios-network/helios-docs.git
$ cd helios-docs
$ yarn install
Run the development server with hot-reload capabilities:
$ yarn start
This command starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.
Generate static files for deployment:
$ yarn build
This will create a build/
directory containing the static site, ready for hosting.
If deploying to GitHub Pages, you can use the following commands:
$ USE_SSH=true yarn deploy
$ GIT_USER=<Your GitHub username> yarn deploy
This command builds the website and pushes the updates to the gh-pages
branch.
We encourage community contributions! If you’d like to help improve the Helios Docs:
- Fork the repository.
- Create a new branch for your changes.
- Submit a pull request (PR) for review.
For major changes, please open an issue first to discuss potential updates.
Join the Helios community and help build the future of decentralized networks!
Unite. Build. Innovate. 🚀
To run the documentation site locally:
# Clone the repository
git clone https://github.com/helios-network/helios-docs.git
# Navigate into the project directory
cd helios-docs
# Install dependencies
npm install
# Start the development server
npm run dev