Skip to main content

Automate FInding and Fixing typos in large scale documentation

Good day guys, so i decided to write a bash script to automate, find and fix typos in large documentations either as a contributor or as a project maintainer.

Well i will like to say, this shouldnt be abused, Always make quality contribution and not quantity contribution to OSS Projects.

So lets get started;

Git clone the script from my github gist

git clone https://gist.github.com/b194aa4aba5bdaab8b74011fe9379ad3.git bulk-typos

Now navigate into the folder "bulk-typo"

cd bulk-typo
ls

Next give the scriopt an executing right using the below command

chmod +x bulk-typo-check.sh

Create a url file to add all the link of the github documentation repos

touch urls.txt

Then open the file to add the docs github repo urls.

nano urls.txt
Add Github URLs

After adding the links, press CNTRL + x, and then enter Y, and click enter.

When you are done, run the script and add the file where you want the output of your typos and the file that contains the github url of the documentation repos.

./bulk-typo-check.sh OUTPUTFILE.txt urls.txt

e.g

./bulk-typo-check.sh mytypos.txt urls.txt

When the script is done running, you can find all the typos in the mytypos.txt file, just run

cat mytypos.txt
Bulk Typo Result