Status Network Documentation

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.

🚀 Getting Started

Prerequisites

• Node.js (v18 or higher)
• Yarn (v1 or higher)
• Git

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.

Installation

# Clone the repository
git clone https://github.com/status-network/docs.git
cd docs

# Install dependencies
yarn

Local Development

# Start the development server
yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

# Build the static site
yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

CI/CD

• CI builds master and pushes to deploy-master branch, which is hosted at https://docs.status.network/.
• CI builds dev develop and pushes to deploy-develop branch, 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.

📝 Contributing

We welcome contributions from the community! Here's how you can help improve our documentation:

Making Changes

1. Fork the repository
2. Create a new branch: git checkout -b feature/your-feature-name
3. Make your changes
4. Test locally using yarn start
5. Commit your changes: git commit -am 'Add some feature'
6. Push to the branch: git push origin feature/your-feature-name
7. Submit a pull request

Documentation Structure

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

Style Guide

When contributing to the documentation, please follow these guidelines:

• Use clear, concise language
• Include code examples where applicable
• Add screenshots or diagrams for complex concepts
• Follow the existing document structure
• Use appropriate frontmatter for all markdown files

Example markdown frontmatter:

---
id: page-id
title: Page Title
description: Brief description of the page
sidebar_position: 1
---

---

Made with ❤️ by the Status Network community