Go to file
2025-11-28 16:10:57 -05:00
docs docs mvp 2025-11-28 15:34:21 -05:00
.gitignore build 2025-11-28 15:40:45 -05:00
.readthedocs.yaml docs mvp 2025-11-28 15:34:21 -05:00
build-webapp.sh missing dep 2025-11-28 16:10:57 -05:00
mkdocs.yml docs mvp 2025-11-28 15:34:21 -05:00
README.md docs mvp 2025-11-28 15:34:21 -05:00
requirements.txt docs mvp 2025-11-28 15:34:21 -05:00

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:

    pip install -r requirements.txt
    
  2. Serve locally:

    mkdocs serve
    

    Visit http://localhost:8000 to view the documentation.

  3. Build static site:

    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:

mkdocs gh-deploy

Configuration

The site configuration is in mkdocs.yml:

  • Navigation structure
  • Theme settings (Material Design)
  • Plugins and extensions
  • Site metadata