Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Documentation Contributions

Accurate and informative documentation is crucial for the success of any open-source project. When contributing to ODP, please ensure that your documentation contributions meet the following standards:

  • 🧠 Clarity: Avoid jargon, explain things simply.
  • 🎯 Relevance: Match doc to the feature or code behavior.
  • 🎨 Consistency: Follow project doc style.
  • 💡 Examples: Show how things work with real usage.
  • ✏️ Review: Accept and apply constructive feedback.
  • 🔄 Updates:Keep docs aligned with code changes.

Whether you are contributing to this documentation in the Documentation repository or adding/updating rustDoc comments in the codebase, your contributions are valuable. They help ensure that ODP remains accessible and understandable to all users and developers.