Welcome to the official documentation for Status Network! This repository contains the source code for our documentation website, built using Docusaurus, a modern static website generator.
If you are familiar with using Nix shell all of the dependencies will be installed by just running nix develop from within this repository which will spawn a new shell.
# Clone the repository
git clone https://github.com/status-network/docs.git
cd docs
# Install dependencies
yarn# Start the development server
yarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
# Build the static site
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
- CI builds
masterand pushes todeploy-masterbranch, which is hosted at https://docs.status.network/. - CI builds dev
developand pushes todeploy-developbranch, which is hosted at https://dev-docs.status.network/.
The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.
Information about deployed build can be also found in /build.json available on the website.
We welcome contributions from the community! Here's how you can help improve our documentation:
- Fork the repository
- Create a new branch:
git checkout -b feature/your-feature-name - Make your changes
- Test locally using
yarn start - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin feature/your-feature-name - Submit a pull request
docs/
├── introduction/ # Introduction and getting started
├── tokenomics/ # SNT and AURA token documentation
├── general-info/ # Network details and contracts
├── tools/ # Development tools and resources
├── tutorials/ # Step-by-step guides
├── security/ # Security information
└── other/ # Additional resources
Made with ❤️ by the Status Network community