60 lines
1.2 KiB
Markdown
60 lines
1.2 KiB
Markdown
# Zenith Documentation
|
|
|
|
Official documentation for the Zenith blockchain ecosystem, built with MkDocs and hosted on ReadTheDocs.
|
|
|
|
## Development Setup
|
|
|
|
### Prerequisites
|
|
- Python 3.8+
|
|
- pip
|
|
|
|
### Local Development
|
|
|
|
1. **Install dependencies**:
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
2. **Serve locally**:
|
|
```bash
|
|
mkdocs serve
|
|
```
|
|
Visit `http://localhost:8000` to view the documentation.
|
|
|
|
3. **Build static site**:
|
|
```bash
|
|
mkdocs build
|
|
```
|
|
|
|
## Content Structure
|
|
|
|
- `docs/overview/` - Introduction and key concepts
|
|
- `docs/documentation/` - Technical documentation
|
|
- `docs/tokenomics/` - Token economy and distribution
|
|
- `docs/command-reference/` - CLI command references
|
|
- `docs/public-infrastructure.md` - Public infrastructure details
|
|
|
|
## Contributing
|
|
|
|
1. Edit markdown files in the `docs/` directory
|
|
2. Test locally with `mkdocs serve`
|
|
3. Submit pull requests with changes
|
|
|
|
## Deployment
|
|
|
|
Documentation is automatically deployed to ReadTheDocs when changes are pushed to the main branch.
|
|
|
|
### Manual Deployment
|
|
|
|
For testing deployment:
|
|
```bash
|
|
mkdocs gh-deploy
|
|
```
|
|
|
|
## Configuration
|
|
|
|
The site configuration is in `mkdocs.yml`:
|
|
- Navigation structure
|
|
- Theme settings (Material Design)
|
|
- Plugins and extensions
|
|
- Site metadata |