[WIP] Improve readability of rules by moving meta info - #177
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #177 +/- ##
=======================================
Coverage 93.24% 93.24%
=======================================
Files 113 113
Lines 12202 12202
=======================================
Hits 11378 11378
Misses 498 498
Partials 326 326 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Updated all 38 rule README files to move meta-information bullets from after description to a new "Meta-Information" section at the end - Updated internal/rules/proto.md schema to reflect new structure - All mdsmith checks pass - All tests pass Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/6b403bfb-b3f1-4f0e-94e4-5a49f18cc48e Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Moves the per-rule rendered meta-information block (ID, status, default, etc.) to the end of each rule README to improve scan-ability and keep the descriptive content up front, aligning with the rule README proto template used by required-structure.
Changes:
- Updated
internal/rules/proto.mdto place the meta-information section at the end of the template. - Reordered content in rule READMEs (MDS001–MDS038) to move the existing meta-information bullets into a final
## Meta-Informationsection.
Reviewed changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| internal/rules/proto.md | Moves the template meta-information block to the end and introduces a ## Meta-Information section. |
| internal/rules/MDS001-line-length/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS002-heading-style/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS003-heading-increment/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS004-first-line-heading/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS005-no-duplicate-headings/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS006-no-trailing-spaces/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS007-no-hard-tabs/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS008-no-multiple-blanks/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS009-single-trailing-newline/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS010-fenced-code-style/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS011-fenced-code-language/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS012-no-bare-urls/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS013-blank-line-around-headings/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS014-blank-line-around-lists/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS015-blank-line-around-fenced-code/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS016-list-indent/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS017-no-trailing-punctuation-in-heading/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS018-no-emphasis-as-heading/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS019-catalog/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS020-required-structure/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS021-include/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS022-max-file-length/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS023-paragraph-readability/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS024-paragraph-structure/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS025-table-format/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS026-table-readability/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS027-cross-file-reference-integrity/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS028-token-budget/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS029-conciseness-scoring/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS030-empty-section-body/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS031-unclosed-code-block/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS032-no-empty-alt-text/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS033-directory-structure/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS034-markdown-flavor/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS035-toc-directive/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS036-max-section-length/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS037-duplicated-content/README.md | Moves meta-information block to the end under ## Meta-Information. |
| internal/rules/MDS038-toc/README.md | Moves meta-information block to the end under ## Meta-Information. |
Move the [source](./) link to its own indented line to match the format used in all other rule READMEs and the proto template. Agent-Logs-Url: https://github.com/jeduden/mdsmith/sessions/b0b4d651-f744-4490-85bf-53e588a6ad87 Co-authored-by: jeduden <1117699+jeduden@users.noreply.github.com>
|
🟢 Merge Queue — picked up This PR is in the queue and will be batched with other Next: No action needed — you'll get another comment when CI starts on the batch. View merge queue run. |
|
🔵 Merge Queue — CI running Merged into batch branch Next: No action needed — you'll be notified when CI completes. |
|
✅ Merge Queue — merged This PR landed on Next: Done — nothing more to do here. |
Thanks for asking me to work on this. I will get started on it and keep this PR's description up to date as I form a plan and make progress.