Spell check the documentation #167
Description
As part of our spring cleaning, we want to detect spell issues in our documentation and fix it when possible. Here's a potential plan to tackle this issue:
- We suggest to start checking out the main branch.
- Identify the files that contain documentation. These are typically
.md(Markdown) or.md.in(a Markdown file to be generated byCMake). - Install in your system a tool to check for spelling errors (e.g.:
aspellin Ubuntu). - Run the spell checks in all the documents. Most of the catches will be false positives due to words like
Protobuf,CMakeand other words that aren't typically in an English dictionary. Ignore all of these until you catch a real spell problem. - Fix it. Usually these programs recommend a proper word or you can later manually modify the file with the correct English term.
- Create a pull request with your fixes. This guide can be helpful. Don't be shy, we'll be kind during the process and help you if you don't have much experience with Gazebo yet or the instructions are not clear enough.