Offer: Docs markdown linting and spell-checking for PRs

[SeanKilleen]

I thought I would offer this in case it's useful.

I've added markdown linting and spellchecking to the NUnit docs, the akka.net docs, and the Marten docs.

This is typically done by adding a parallel job that runs the node tooling, and all of the corrections that go with a tool (the Akka .NET issue shows how I'd take this step by step).

Proposed Steps

• Add spell-checking via cSpell feat: Automated Spell-check for docs and associated spelling fixes #10080
• Add markdown lint GitHub action with all rules explicitly disabled in config
• Subsequent PRs to enable rule(s) along with their fixes.

[jeromelaban]

Thanks Sean! Indeed that would be very interesting!

[Youssef1313]

I made a small progress in https://github.com/Youssef1313/uno/tree/markdownlint, anyone is welcome to work on top of it.

GitHub

GitHub - Youssef1313/uno at markdownlint

Build Mobile, Desktop and WebAssembly apps with C# and XAML. Today. Open source and professionally supported. - GitHub - Youssef1313/uno at markdownlint

[SeanKilleen]

I've been meaning to pick this up for a minute. Got the Hacktoberfest email and reminded me of it. Going to start the first PR for this today.

[MartinZikmund]

@SeanKilleen Are you planning to work on the markdown linting?

[SeanKilleen]

@MartinZikmund whoops, sorry about that! I'll bump this back up to the top of my radar.

[MartinZikmund]

No worries, was just walking through the backlog to make sure issues are still current 😊

[SeanKilleen]

@MartinZikmund double-oops! This was already completed in #10080 back in October. It was linked to this but didn't close the issue, and I forgot it was already done because I had done several projects at the same time 😅

Going to go ahead and close this out. 👍

[SeanKilleen]

Annnnd re-opening because I realized we're talking about markdown linting and not spelling. 🤦‍♂️