fix markdown nits - Githubissues

ferrous-systems / rust-training

Learning materials for the Rust Training courses by Ferrous Systems

127 stars 16 forks source link

fix markdown nits #98

Closed miguelraz closed 9 months ago

miguelraz commented 10 months ago

Fixed a bunch of nits the VSCode MarkdownLint extension had.

This sped up my editing experience a bit and I think the team should default to using it tbh.

miguelraz commented 10 months ago

Andrei noted in chat:

We can enable this in CI with https://github.com/marketplace/actions/markdownlint-cli2-action
We shouldn't wreck our git blame
We can enable per file ignores with Disable one or more rules by name:

listochkin commented 10 months ago

IMO Let's look at current violations first, agree on the set of rules we want to enforce, build an config file, and only then do these sweeping changes.

miguelraz commented 9 months ago

Conclusion:

Not worth the hassle for now.