Skip to content

Fix markdownlint issues#4998

Merged
LoopedBard3 merged 3 commits intodotnet:mainfrom
xtqqczze:fix-markdownlintissues
Mar 23, 2026
Merged

Fix markdownlint issues#4998
LoopedBard3 merged 3 commits intodotnet:mainfrom
xtqqczze:fix-markdownlintissues

Conversation

@xtqqczze
Copy link
Contributor

@xtqqczze xtqqczze commented Oct 1, 2025

Enable the rules disabled in #4995

  • Exclude eng/common since these files are from https://github.com/dotnet/arcade.
  • Add a <!-- markdownlint-disable --> directive for files in reports/net9to10/
  • Fix MD059/descriptive-link-text : Link text should be descriptive
  • Fix MD047/single-trailing-newline : Files should end with a single newline character

Fix #4996

@xtqqczze xtqqczze force-pushed the fix-markdownlintissues branch from 35b98c3 to 3b3e594 Compare October 1, 2025 13:45
@xtqqczze xtqqczze marked this pull request as ready for review October 1, 2025 13:48
@xtqqczze xtqqczze force-pushed the fix-markdownlintissues branch from 4478116 to 97fd115 Compare October 1, 2025 16:06
@xtqqczze xtqqczze force-pushed the fix-markdownlintissues branch 2 times, most recently from ea300df to f8d712b Compare March 2, 2026 19:25
@xtqqczze xtqqczze force-pushed the fix-markdownlintissues branch 2 times, most recently from 05008e7 to c4cfe1c Compare March 21, 2026 20:06
* Exclude `eng/common` since these files are from https://github.com/dotnet/arcade.
* Add a `<!-- markdownlint-disable -->` directive for files in `reports/net9to10/`
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR re-enables previously disabled markdownlint rules and updates Markdown content/configuration to bring the repo back into compliance, while excluding Arcade-sourced Markdown and suppressing linting for generated net9→10 report files.

Changes:

  • Re-enabled multiple markdownlint rules in .markdownlint.jsonc and updated the GitHub Actions workflow to use an ignore file.
  • Added .markdownlintignore (excluding eng/common/) and added <!-- markdownlint-disable --> to generated reports/net9to10/*_report.md files.
  • Fixed MD059 (descriptive link text) and MD047 (single trailing newline) violations across several docs/reports.

Reviewed changes

Copilot reviewed 20 out of 21 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/benchmarks/gc/GC.Infrastructure/README.md Updates link text to satisfy MD059; minor wording tweaks.
src/benchmarks/gc/GC.Infrastructure/Notebooks/README.md Makes link text descriptive for MD059 compliance.
docs/benchmarkdotnet.md Makes link text descriptive for MD059 compliance.
reports/net9to10/README.md Fixes formatting/newline consistency for lint compliance.
reports/net9to10/*_report.md Adds markdownlint-disable directives and fixes trailing-newline/formatting issues in generated reports.
.markdownlintignore Introduces ignore list (notably eng/common/).
.markdownlint.jsonc Re-enables previously-disabled rules (MD001/MD012/MD031/MD033/MD036/MD047/MD051/MD052/MD059).
.github/workflows/markdownlint.yml Uses .markdownlintignore via --ignore-path when running markdownlint.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


1. Legend column should contain the name of the ASP.NET benchmark followed by an underscore and the name of the OS.
2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found [here](#how-to-add-new-benchmarks).
2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found in the next section.
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change removes the in-doc anchor link that previously navigated readers to the relevant section. To keep the document easy to navigate while satisfying MD059, consider linking directly with descriptive text (e.g., a link to the “How To Add New Benchmarks” section) instead of referring to “the next section” without a link.

Suggested change
2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found in the next section.
2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found in the [How To Add New Benchmarks](#how-to-add-new-benchmarks) section.

Copilot uses AI. Check for mistakes.
- name: Run markdownlint
run: |
markdownlint --config ./.markdownlint.jsonc '**/*.md'
markdownlint --config ./.markdownlint.jsonc --ignore-path ./.markdownlintignore '**/*.md'
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the workflow now relies on --ignore-path ./.markdownlintignore, consider adding .markdownlintignore to the on.pull_request.paths filter so updates to the ignore list will also trigger this workflow (otherwise changes to the ignore file alone won’t be validated).

Copilot uses AI. Check for mistakes.
Copy link
Member

@LoopedBard3 LoopedBard3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@LoopedBard3 LoopedBard3 merged commit 032d797 into dotnet:main Mar 23, 2026
77 of 79 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix markdownlint rules

3 participants