Documentation site for Status Network https://docs.status.network
Go to file
nadeemb53 2e1c23b4ca
intro content, css bug fixes, css improvements, translated docs
2024-10-26 15:27:16 +05:30
.github fix: Navigation bar cosmetic fixes (#2) 2024-10-24 19:11:17 +02:00
docs intro content, css bug fixes, css improvements, translated docs 2024-10-26 15:27:16 +05:30
i18n intro content, css bug fixes, css improvements, translated docs 2024-10-26 15:27:16 +05:30
src/css intro content, css bug fixes, css improvements, translated docs 2024-10-26 15:27:16 +05:30
static initial commit 2024-10-24 21:09:46 +05:30
.gitignore fix: Navigation bar cosmetic fixes (#2) 2024-10-24 19:11:17 +02:00
README.md intro content, css bug fixes, css improvements, translated docs 2024-10-26 15:27:16 +05:30
babel.config.js initial commit 2024-10-24 21:09:46 +05:30
docusaurus.config.ts intro content, css bug fixes, css improvements, translated docs 2024-10-26 15:27:16 +05:30
package.json initial commit 2024-10-24 21:09:46 +05:30
sidebars.ts initial commit 2024-10-24 21:09:46 +05:30
tsconfig.json initial commit 2024-10-24 21:09:46 +05:30
yarn.lock yarn fix 2024-10-24 22:05:17 +05:30

README.md

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

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.

📝 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

Made with ❤️ by the Status Network community