This repository hosts the unified documentation site for the Verdikta ecosystem at docs.verdikta.org.
Verdikta coordinates work across repositories through the Verdikta Master Backlog. Humans and automated agents contributing here must read AGENTS.md and the canonical backlog and issue workflow before creating, selecting, or changing work items.
verdikta-docs/
├── mkdocs.yml ← Main configuration & navigation
├── docs/ ← Native documentation (overview, changelog)
├── assets/ ← Shared images and stylesheets
└── sources/ ← Git submodules (private repos)
├── arbiter/ ← verdikta-arbiter → Node Operators docs
├── apps/ ← verdikta-applications → Developers docs
├── common/ ← verdikta-common → Common Library docs
└── dispatcher/ ← verdikta-dispatcher → Smart Contracts docs
# Clone with submodules
git clone --recursive git@github.com:verdikta/verdikta-docs.git
cd verdikta-docs
# Install dependencies
pip install -r requirements.txt
# Serve locally
mkdocs serveView at http://localhost:8000
mkdocs build- Source repositories contain component-specific documentation in their
docs/folders - Git submodules link those docs into this repository
- GitHub Actions automatically updates submodules every 6 hours
- MkDocs monorepo plugin combines all docs into a single site
- Vercel hosts the built site at docs.verdikta.org
See CONTRIBUTING.md for detailed instructions on:
- Adding native documentation to this repo
- Adding documentation in submodule repositories
- Connecting new docs to the main site
- Local development and testing
| Section | Source | Description |
|---|---|---|
| Node Operators | sources/arbiter/installer/docs/ |
Installation, management, troubleshooting |
| Developers | sources/apps/docs/ |
SDK, API, example applications |
| Common Library | sources/common/docs/ |
Shared utilities, manifest specification |
| Smart Contracts | sources/dispatcher/docs/ |
Contract integration, API reference |
| Overview | docs/overview/ |
Architecture, whitepaper |
| Changelog | docs/changelog/ |
Release notes |
- verdikta-arbiter - Arbiter node software
- verdikta-dispatcher - Smart contracts
- verdikta-applications - Example applications
- verdikta-common - Shared utilities
- Documentation Issues: GitHub Issues
- General Questions: Discord Community
- Email: support@verdikta.org
Built with MkDocs Material