Implement MkDocs documentation site with Material theme and GitHub Pages deployment

.github/workflows/deploy.yml

@@ -0,0 +1,64 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Build with MkDocs
+        run: mkdocs build --clean --strict
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -0,0 +1,40 @@
+# MkDocs
+site/
+.cache/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Logs
+*.log
+logs/
+
+# Temporary files
+*.tmp
+*.temp
+.temp/

README.md

@@ -1,2 +1,92 @@
-# docs
-content for docs.bitsec.ai
+# Bitsec-AI Documentation
+
+This repository contains the documentation for [docs.bitsec.ai](https://docs.bitsec.ai), providing comprehensive guides for Bittensor subnet operators including validators and miners.
+
+## 🚀 Quick Start
+
+This documentation site is built with [MkDocs](https://www.mkdocs.org/) and the [Material theme](https://squidfunk.github.io/mkdocs-material/).
+
+### Local Development
+
+1. **Install dependencies:**
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+2. **Serve locally:**
+   ```bash
+   mkdocs serve
+   ```
+   The site will be available at `http://localhost:8000`
+
+3. **Build static site:**
+   ```bash
+   mkdocs build
+   ```
+
+## 📚 Documentation Structure
+
+- **Getting Started**: Basic setup and installation guides
+- **For Validators**: Comprehensive validator operation guides
+- **For Miners**: Mining setup, optimization, and best practices  
+- **Subnet Operations**: Architecture, monitoring, and troubleshooting
+- **API Reference**: Complete API documentation
+
+## 🔧 Site Configuration
+
+The site is configured via `mkdocs.yml` with:
+
+- **Material theme** with dark/light mode support
+- **Navigation tabs** for easy browsing
+- **Code highlighting** and copy functionality
+- **Search** functionality
+- **Mobile responsive** design
+
+## 🚀 Deployment
+
+The site automatically deploys to GitHub Pages via GitHub Actions when changes are pushed to the `main` branch.
+
+### Manual Deployment
+
+```bash
+mkdocs gh-deploy
+```
+
+## 🤝 Contributing
+
+We welcome contributions to improve this documentation:
+
+1. Fork this repository
+2. Create a feature branch
+3. Make your changes
+4. Test locally with `mkdocs serve`
+5. Submit a pull request
+
+### Writing Guidelines
+
+- Use clear, concise language
+- Include code examples where helpful
+- Add screenshots for UI-related content
+- Follow the existing structure and style
+- Test all links and references
+
+## 📋 Requirements
+
+- Python 3.8+
+- MkDocs 1.5.0+
+- MkDocs Material 9.4.0+
+- PyMdown Extensions 10.3.0+
+
+## 📝 License
+
+This documentation is licensed under the MIT License. See [LICENSE](LICENSE) for details.
+
+## 🔗 Links
+
+- **Live Site**: [docs.bitsec.ai](https://docs.bitsec.ai)
+- **GitHub Repository**: [Bitsec-AI/docs](https://github.com/Bitsec-AI/docs)
+- **Bitsec-AI Main**: [Bitsec-AI](https://github.com/Bitsec-AI)
+
+---
+
+*Documentation for the Bitsec-AI subnet on the Bittensor network*

docs/api/overview.md

@@ -0,0 +1,73 @@
+# API Overview
+
+The Bitsec-AI API provides programmatic access to subnet functionality for advanced users and developers.
+
+## Authentication
+
+All API requests require authentication using API keys:
+
+```bash
+curl -H "Authorization: Bearer YOUR_API_KEY" \
+     https://api.bitsec.ai/v1/status
+```
+
+## Base URL
+
+```
+https://api.bitsec.ai/v1
+```
+
+## Endpoints
+
+### Health Check
+
+```http
+GET /health
+```
+
+Returns the current status of the API service.
+
+### Validator Status
+
+```http
+GET /validators/{validator_id}/status
+```
+
+Get the current status of a specific validator.
+
+### Miner Status
+
+```http
+GET /miners/{miner_id}/status
+```
+
+Get the current status of a specific miner.
+
+### Subnet Metrics
+
+```http
+GET /subnet/metrics
+```
+
+Retrieve current subnet performance metrics.
+
+## Rate Limits
+
+- 1000 requests per hour for authenticated users
+- 100 requests per hour for unauthenticated requests
+
+## SDK
+
+We provide official SDKs for popular programming languages:
+
+- Python: `pip install bitsec-sdk`
+- JavaScript: `npm install @bitsec/sdk`
+- Go: `go get github.com/bitsec-ai/go-sdk`
+
+## Support
+
+For API support:
+
+- Check our [troubleshooting guide](../subnet/troubleshooting.md)
+- Visit our GitHub repository
+- Contact our developer support team

docs/getting-started/installation.md

@@ -0,0 +1,111 @@
+# Installation
+
+This guide will walk you through installing the necessary components to get started with Bitsec-AI.
+
+## System Requirements
+
+### Minimum Requirements
+- **OS**: Ubuntu 20.04 LTS or later, macOS 10.15+, or Windows 10+
+- **RAM**: 8GB minimum, 16GB recommended
+- **Storage**: 100GB available space
+- **Network**: Stable internet connection with good bandwidth
+
+### Recommended Requirements
+- **RAM**: 32GB or more
+- **Storage**: 500GB SSD
+- **CPU**: Multi-core processor (8+ cores recommended)
+
+## Installation Steps
+
+### 1. Install Python
+
+Ensure you have Python 3.8 or higher:
+
+```bash
+python3 --version
+```
+
+If you need to install Python:
+
+=== "Ubuntu/Debian"
+    ```bash
+    sudo apt update
+    sudo apt install python3 python3-pip python3-venv
+    ```
+
+=== "macOS"
+    ```bash
+    # Using Homebrew
+    brew install python3
+    ```
+
+=== "Windows"
+    Download Python from [python.org](https://python.org) and follow the installation wizard.
+
+### 2. Install Git
+
+```bash
+git --version
+```
+
+If Git is not installed:
+
+=== "Ubuntu/Debian"
+    ```bash
+    sudo apt install git
+    ```
+
+=== "macOS"
+    ```bash
+    brew install git
+    ```
+
+=== "Windows"
+    Download Git from [git-scm.com](https://git-scm.com) and install.
+
+### 3. Clone the Repository
+
+```bash
+git clone https://github.com/Bitsec-AI/subnet
+cd subnet
+```
+
+### 4. Set Up Virtual Environment
+
+```bash
+python3 -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+### 5. Install Dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+## Verification
+
+To verify your installation:
+
+```bash
+python3 -c "import bittensor; print('Bittensor installed successfully')"
+```
+
+## Next Steps
+
+Now that you have everything installed:
+
+- **Validators**: Proceed to [Validator Introduction](../validators/introduction.md)
+- **Miners**: Proceed to [Miner Introduction](../miners/introduction.md)
+
+## Troubleshooting
+
+### Common Issues
+
+**Python version conflicts**: Use `python3` explicitly instead of `python`.
+
+**Permission errors**: Use virtual environments to avoid system-wide installations.
+
+**Network issues**: Ensure your firewall allows the necessary connections.
+
+For more help, see our [troubleshooting guide](../subnet/troubleshooting.md).