Created
February 22, 2026 04:47
-
-
Save scode/44c30b00ef5d18c4a2474138a7088234 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ## Learning-first documentation style | |
| This project is primarily for learning. Optimize for teaching clarity over terseness. | |
| - Use Rust doc comments (`///` and `//!`) liberally on modules, types, fields, and functions. | |
| - It is acceptable for docstrings to be repetitive if repetition helps learners connect concepts. | |
| - Prefer didactic explanations of "what", "why", and "how" even when this increases verbosity. | |
| - Include concrete API context in docs (for example, what schedule/system set a Bevy system belongs to, or why a specific Bevy/egui type is used). | |
| - When in doubt, choose more explanation rather than less. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment