Adding readability report and beginnings of markdown linter

[cansavvy]

Summary

Try out a markdown linter -- let's see how these work. Just formulating ideas right now. Ideally I don't want to create one from scratch.

[github-actions]

No spelling errors! 🎉
Comment updated at 2025-01-10-20:16:55 with changes from e3f0e1f

[github-actions]

No broken url errors! 🎉
Comment updated at 2025-01-10-20:16:57 with changes from e3f0e1f

[github-actions]

Re-rendered previews from the latest commit:

• 👀 Quick preview of course website here *
• 🔬 Comprehensive download of the course website here
• Download the .docx file

* note not all html features will be properly displayed in the "quick preview" but it will give you a rough idea.

Updated at 2025-01-10 with changes from the latest commit e3f0e1f

[cansavvy]

Overall readability score: 57.92 (🟢 +0.07)

File	Readability
README.md	64.84 (🟢 +1.66)

View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File	Readability	FRE	GF	ARI	CLI	DCRS
README.md	64.84	52.76	8.23	9.5	12.15	7.94
	🟢 +1.66	🟢 +0.3	🟢 +0	🟢 +0.4	🟢 +0.41	🟢 +0.14

Averages:

	Readability	FRE	GF	ARI	CLI	DCRS
Average	57.92	51.12	10.12	13.09	12.18	7.37
	🟢 +0.07	🟢 +0.01	🟢 +0	🟢 +0.02	🟢 +0.02	🟢 +0.01

View metric targets

Metric	Range	Ideal score
Flesch Reading Ease	100 (very easy read) to 0 (extremely difficult read)	60
Gunning Fog	6 (very easy read) to 17 (extremely difficult read)	8 or less
Auto. Read. Index	6 (very easy read) to 14 (extremely difficult read)	8 or less
Coleman Liau Index	6 (very easy read) to 17 (extremely difficult read)	8 or less
Dale-Chall Readability	4.9 (very easy read) to 9.9 (extremely difficult read)	6.9 or less

[cansavvy]

So this works! But its quite a lot to wade through: https://github.com/jhudsl/OTTR_Template/actions/runs/12676850739/job/35330923187

I would have preferred to just have a report that we could ignore or not.

[github-actions]

Markdown linter report here
Updated at 2025-01-10 with changes from the latest commit e3f0e1f