Noderr Documentation This repository contains the official Noderr Protocol documentation, built with GitBook (HonKit) and deployed at https://docs.noderr.xyz/
📚 Documentation Structure The documentation is organized into the following sections:
Core Documentation - introduction/ - Introduction to Noderr and core concepts - getting-started/ - Getting started guides for users, node operators, and developers - protocol/ - Protocol architecture, governance, and technical details - node-operators/ - Node operator guides and requirements - tokenomics/ - Token distribution and economic model
Additional Resources - developers/ - Developer guides and API documentation - api/ - API reference documentation - architecture/ - Technical architecture documentation - audit-reports/ - Security audits and reports - white-papers/ - Whitepapers and research documents - resources/ - Additional resources and links - assets/ - Images, diagrams, and media files
System Files - gitbook/ - GitBook theme and assets (DO NOT MODIFY) - index.html - GitBook entry point (auto-generated)
🔨 Building Documentation The documentation is built using HonKit (GitBook alternative): bash # Install dependencies npm install -g honkit # Build the documentation honkit build # The output is served at https://docs.noderr.xyz/
📝 Writing Documentation All documentation is written in Markdown format. Each section has its own directory with: - README.md - Section overview - Subdirectories for related topics - Individual .md files for specific pages
🚀 Deployment The documentation is automatically deployed to https://docs.noderr.xyz/ when changes are pushed to the branch.
Deployment Process 1. Make changes to markdown files 2. Commit and push to GitHub 3. HonKit build is triggered 4. Static site is deployed to docs.noderr.xyz
📋 Contributing When contributing to the documentation: 1. Use Markdown - All content should be in .md format 2. Follow Structure - Place content in appropriate directories 3. Update Navigation - Ensure pages are properly linked 4. Test Links - Verify all internal links work 5. Use Clear Language - Write for clarity and accessibility
⚠️ Notes - Do NOT modify the gitbook/ directory or index.html - these are auto-generated - Use GitBook URLs - All links should point to https://docs.noderr.xyz/ - Avoid MkDocs - This repository uses GitBook (HonKit), not MkDocs - Keep it organized - Maintain the directory structure for clarity