Bug: adding text to parser docs causes pre commit errors

[ran-isenberg]

Expected Behaviour

docs-linter passes but pre-commit fails

Current Behaviour

docs/utilities/parser.md:586 MD043/required-headings/required-headers Required heading structure [Context: "## Getting started"]

Code snippet

(.venv) ➜  aws-lambda-powertools-python git:(func_url) ✗ make pre-commit
pre-commit run --show-diff-on-failure
Check for merge conflicts................................................Passed
Trim Trailing Whitespace.................................................Passed
Check Toml...........................................(no files to check)Skipped
formatting::black....................................(no files to check)Skipped
formatting::isort....................................(no files to check)Skipped
linting::flake8......................................(no files to check)Skipped
markdownlint.............................................................Failed
- hook id: markdownlint
- exit code: 1

docs/utilities/parser.md:586 MD043/required-headings/required-headers Required heading structure [Context: "## Getting started"]

AWS CloudFormation Linter............................(no files to check)Skipped
make: *** [pre-commit] Error 1

Possible Solution

No response

Steps to Reproduce

make pre-commit

AWS Lambda Powertools for Python version

latest

AWS Lambda function runtime

3.8

Packaging format used

PyPi

Debugging logs

(.venv) ➜  aws-lambda-powertools-python git:(func_url) ✗ make pre-commit
pre-commit run --show-diff-on-failure
Check for merge conflicts................................................Passed
Trim Trailing Whitespace.................................................Passed
Check Toml...........................................(no files to check)Skipped
formatting::black....................................(no files to check)Skipped
formatting::isort....................................(no files to check)Skipped
linting::flake8......................................(no files to check)Skipped
markdownlint.............................................................Failed
- hook id: markdownlint
- exit code: 1

docs/utilities/parser.md:586 MD043/required-headings/required-headers Required heading structure [Context: "## Getting started"]

AWS CloudFormation Linter............................(no files to check)Skipped
make: *** [pre-commit] Error 1

[heitorlessa]

Thanks Ran for the productiveness in creating an issue but that's a deliberate linting rule to ensure consistency across headings. It'll fail on updates to docs not following it.

Closing as we're tracking Parser doc refactoring on #1371

[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.