Maintenance: start linting markdown files

[dreamorosi]

Summary

Currently we don't have any linting in place for the documentation.

This leads to inconsistencies when different contributors touch the files, which in some cases lead to increased diff on PRs.

We should take inspiration from the Powertools for AWS Lambda (Python) repo and setup something like (or exactly) markdownlint.

Why is this needed?

So that we can increase consistency and remove cognitive overhead during editing & review.

Which area does this relate to?

Automation

Solution

• Explore adding markdownlint to the repo
• Consider adopting most or all the same linting rules that the Python repo uses
• Set up the tool to run during PRs CI on all markdown files
• Set up the tool to run on changed files as pre-commit hook

Acknowledgment

• This request meets Powertools for AWS Lambda (TypeScript) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Python, Java, and .NET

Future readers

Please react with 👍 and your use case to help us understand customer demand.

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

[github-actions]

This is now released under v2.1.1 version!