Typos found in docs and community pages #871
Description
Page URL (if applicable)
http://127.0.0.1:4000/docs.html & http://127.0.0.1:4000/community.html
What should be improved?
Background
Yesterday while I was reding the docs of preCICE and I found a small typo there.
(It must be "Create a Python " and not "Create an Python")
This led me to think the docs can have more typos in them — so lets find them.
What I Did
I wrote a script that:
- Scrapped all the pages under
/docsand/community - Scrapped their text content
- Sent it to a model and processed whether or not that content was having typos or not
Result
After this I got some 73 typos across these 2 routes.
The report and json file for this can be found below.
Attachments
report.pdf— full typo audit reportreport.json— raw typo data
Solution
Just like I ran a script for finding the typos, we can run a similar script for changing the docs as well. It can go through all the pages, find the typos from the json we already have, and directly fix them in the source files. So we dont have to go and change each one manually.
I have written a small script, once the PRs are open I will make the PR for making the typo changes