Skip to content

Fix non-descriptive link text in Markdown documentation #62004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 20, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented May 20, 2025

This PR fixes Markdown linting errors related to non-descriptive link text in several documentation files. The linter was reporting errors with the message:

MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]

The changes replace all instances of generic "[here]" link text with more descriptive text that explains what each link points to:

  1. In docs/AddingNewProjects.md: Changed "[here]" to "[tutorial on filtered solutions in Visual Studio]"
  2. In docs/DailyBuilds.md: Changed "[here]" to "[ASP.NET Core nightly builds section]"
  3. In docs/WebTransport.md:
    • Changed first "[here]" to "[Google WebTransport sample repository]"
    • Changed second "[here]" to "[HTTP/3 Error Codes specification]"

The changes are minimal, only updating the link text while preserving all URLs intact to maintain functionality.

Fixes #62003.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
@captainsafia captainsafia marked this pull request as ready for review May 20, 2025 01:03
@captainsafia captainsafia self-requested a review as a code owner May 20, 2025 01:03
@captainsafia captainsafia changed the title [WIP] Non-required build failures due to new Markdown rules Non-required build failures due to new Markdown rules May 20, 2025
@Copilot Copilot AI changed the title Non-required build failures due to new Markdown rules Fix non-descriptive link text in Markdown documentation May 20, 2025
Copilot finished work on behalf of captainsafia May 20, 2025 01:04
@captainsafia
Copy link
Member

@danmoseley Can you give this a review?

Copy link
Member

@wtgodbe wtgodbe left a comment

Choose a reason for hiding this comment

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

Cool!

@captainsafia captainsafia merged commit 795e202 into main May 20, 2025
8 checks passed
@captainsafia captainsafia deleted the copilot/fix-62003 branch May 20, 2025 19:18
@dotnet-policy-service dotnet-policy-service bot added this to the 10.0-preview5 milestone May 20, 2025
@danmoseley
Copy link
Member

should we pin the markdown tool though?

@captainsafia
Copy link
Member

@copilot Can you open a PR that pins the markdownlint-cli version that is used in the markdownlint.yml workflow to 0.45.0?

@captainsafia
Copy link
Member

captainsafia commented May 20, 2025

Boo! It would be awesome if that worked but it looks like we have to file an issue to initiate it.

See #62033.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Non-required build failures due to new Markdown rules
4 participants