File tree Expand file tree Collapse file tree 1 file changed +31
-0
lines changed Expand file tree Collapse file tree 1 file changed +31
-0
lines changed Original file line number Diff line number Diff line change @@ -125,11 +125,42 @@ Each component directory contains a `summary.md` file documenting:
125125- Implementation notes
126126- Refactoring plans
127127
128+ ## Documentation Website
129+
130+ OpenMina includes a comprehensive documentation website built with Docusaurus:
131+
132+ ### Quick Access
133+ ``` bash
134+ # Start local documentation server
135+ make docs-serve
136+
137+ # Build documentation
138+ make docs-build
139+
140+ # Other documentation commands
141+ make help | grep docs
142+ ```
143+
144+ The website is available at http://localhost:3000 when running locally.
145+
146+ ### Structure
147+ - ** Node Runners** (` website/docs/node-runners/ ` ) - Installation and operation guides
148+ - ** Developers** (` website/docs/developers/ ` ) - Architecture and contribution guides
149+ - ** Researchers** (` website/docs/researchers/ ` ) - Protocol and cryptography documentation
150+
151+ ### Adding Documentation
152+ 1 . Create markdown files in the appropriate ` website/docs/ ` subdirectory
153+ 2 . Add frontmatter with title, description, and sidebar position
154+ 3 . Update ` website/sidebars.ts ` if needed for navigation
155+
156+ The website supports versioning and will be automatically deployed when commits are made to ` develop ` or when tags are created.
157+
128158## Additional Resources
129159
130160- ` docs/handover/ ` - Comprehensive architecture documentation
131161- ` ARCHITECTURE.md ` - Migration guide for old vs new style
132162- Component-specific ` summary.md ` files throughout the codebase
163+ - ` website/ ` - Docusaurus documentation website
133164
134165## Claude Development Guidelines
135166
You can’t perform that action at this time.
0 commit comments