yjkellyjooandClaude Opus 4.6
d07669f7f2
- Remove pages: false to enable the custom landing page at / - Update Overview nav link from / to /overview - Refresh dark mode palette to dark blue tones (#09101c, #0f1729) - Update navbar/footer dark backgrounds for visual consistency - Add deploy-card grid component styles Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
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-im/docs.status.network
cd docs.status.network
# 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
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.
📝 Contributing
We welcome contributions from the community! Here's how you can help improve our documentation:
Making Changes
- 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
Documentation Structure
docs/
├── introduction/ # Introduction and getting started
├── tokenomics/ # Economic model and Karmic Tokenomics
├── general-info/ # Network details and contracts
├── tools/ # Development tools and resources
├── tutorials/ # Step-by-step guides
└── other/ # Additional resources
Made with ❤️ by the Status Network team