Solutions

[mcclowes]

Description

• Include a summary of the new content you're adding or the reason for the change.
• Include relevant context.
• Do not link to work items.
• Any PNG images should be compressed using Tiny PNG or equivalent.

Type of change

Please delete options that are not relevant.

• New document(s)/updating existing
• Fixes
• Styling
• Bug fix (non-breaking change which fixes an issue)

Reviews and merging

You are responsible for getting your PR merged. Address review comments promptly and make sure to merge the PR when ready.
Feel free to 'Enable automerge' - your PR will automatically merge when accepted and passing the build.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
codat-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 18, 2024 4:35pm

[github-actions]

Overall readability score: 59.8 (🟢 +0)

File	Readability
overview.md	0 (🟢 +0)
overview.md	16.46 (🟢 +0)

View detailed metrics

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

File	Readability	FRE	GF	ARI	CLI	DCRS
overview.md	0	0	19	22	19	11
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0
overview.md	16.46	0	12.49	22	19	9.35
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0

Averages:

	Readability	FRE	GF	ARI	CLI	DCRS
Average	59.8	50.48	10.13	11.24	11.81	7.74
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0

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

[github-actions]

Link check results (filtered):

[]