TheOdinProject / curriculum

The open curriculum for learning web development
https://www.theodinproject.com/
Other
10.12k stars 13.57k forks source link

docs: Added comments for custom markdown rules in .markdowndlint-cli2… #29012

Closed akhilmohnn closed 3 weeks ago

akhilmohnn commented 3 weeks ago

## Because This PR aims to improve clarity within the .markdowndlint-cli2.jsonc file by adding comments that explain the purpose of each custom markdown rule used in the project. This helps contributors and maintainers understand the specific rules being enforced.

## This PR

## Issue This PR does not close any specific issue but contributes to the overall quality and maintainability of the project.

## Additional Information No additional changes were made beyond adding comments.

## Pull Request Requirements

Allow edits by maintainers.

akhilmohnn commented 3 weeks ago

Thank you for the feedback! I’ve updated the .markdowndlint-cli2.jsonc file to include a single general comment for the custom rules array, as suggested. Let me know if there’s anything else I can adjust.

MaoShizhong commented 3 weeks ago

Thank you for the feedback! I’ve updated the .markdowndlint-cli2.jsonc file to include a single general comment for the custom rules array, as suggested. Let me know if there’s anything else I can adjust.

Looks like you forgot to push the commits? This branch hasn't been updated with any changes.

MaoShizhong commented 3 weeks ago

Superceded by #29018