| docs | ||
| .gitignore | ||
| .readthedocs.yaml | ||
| build-webapp.sh | ||
| mkdocs.yml | ||
| README.md | ||
| requirements.txt | ||
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
-
Install dependencies:
pip install -r requirements.txt -
Serve locally:
mkdocs serveVisit
http://localhost:8000to view the documentation. -
Build static site:
mkdocs build
Content Structure
docs/overview/- Introduction and key conceptsdocs/documentation/- Technical documentationdocs/tokenomics/- Token economy and distributiondocs/command-reference/- CLI command referencesdocs/public-infrastructure.md- Public infrastructure details
Contributing
- Edit markdown files in the
docs/directory - Test locally with
mkdocs serve - 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