@@ -130,6 +130,7 @@ Each component directory contains a `summary.md` file documenting:
130130OpenMina includes a comprehensive documentation website built with Docusaurus:
131131
132132### Quick Access
133+
133134``` bash
134135# Start local documentation server
135136make docs-serve
@@ -144,16 +145,22 @@ make help | grep docs
144145The website is available at http://localhost:3000 when running locally.
145146
146147### 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
148+
149+ - ** Node Runners** (` website/docs/node-runners/ ` ) - Installation and operation
150+ guides
151+ - ** Developers** (` website/docs/developers/ ` ) - Architecture and contribution
152+ guides
153+ - ** Researchers** (` website/docs/researchers/ ` ) - Protocol and cryptography
154+ documentation
150155
151156### Adding Documentation
157+
1521581 . Create markdown files in the appropriate ` website/docs/ ` subdirectory
1531592 . Add frontmatter with title, description, and sidebar position
1541603 . Update ` website/sidebars.ts ` if needed for navigation
155161
156- The website supports versioning and will be automatically deployed when commits are made to ` develop ` or when tags are created.
162+ The website supports versioning and will be automatically deployed when commits
163+ are made to ` develop ` or when tags are created.
157164
158165## Additional Resources
159166
@@ -203,7 +210,16 @@ referencing Claude.
203210
2042111 . Make your code changes
2052122 . Run the appropriate formatting command based on file types modified
206- 3 . Verify formatting with check commands if needed
207- 4 . ** Verify commit message does not include Claude as co-author**
208- 5 . ** Verify commit message contains no emojis and follows 80-character wrap**
209- 6 . Proceed with testing or committing changes
213+ 3 . ** ALWAYS run ` make fix-trailing-whitespace ` before committing or ending any task**
214+ 4 . Verify formatting with check commands if needed
215+ 5 . ** Verify commit message does not include Claude as co-author**
216+ 6 . ** Verify commit message contains no emojis and follows 80-character wrap**
217+ 7 . Proceed with testing or committing changes
218+
219+ ### Critical Pre-Commit Requirements
220+
221+ - ** MANDATORY** : Run ` make fix-trailing-whitespace ` before every commit
222+ - ** MANDATORY** : Run ` make check-trailing-whitespace ` to verify no trailing
223+ whitespaces remain
224+ - This applies to ALL file modifications, regardless of file type
225+ - Trailing whitespaces are strictly prohibited in the codebase
0 commit comments