Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 2, 2025

Links in .github/CONTRIBUTING.md and other documentation files used simple relative paths that fail to resolve correctly in certain GitHub rendering contexts (e.g., when displayed via the repository's "Contributing guidelines" feature).

Changes

After comprehensive validation of all 52 markdown files in the repository, updated broken internal links to use repository-root-relative paths (prefixed with /):

.github/CONTRIBUTING.md

  • CODE_OF_CONDUCT.md/.github/CODE_OF_CONDUCT.md
  • DEVELOPMENT.md/.github/DEVELOPMENT.md
  • PULL_REQUEST_TEMPLATE.md/.github/PULL_REQUEST_TEMPLATE.md (2 instances)
  • ../src/Core/tests/Benchmarks//src/Core/tests/Benchmarks/

.github/copilot-instructions.md

  • .github/DEVELOPMENT.md/.github/DEVELOPMENT.md
  • docs/DevelopmentTips.md/docs/DevelopmentTips.md
  • .github/CONTRIBUTING.md/.github/CONTRIBUTING.md

docs/README.md

  • BuildFromSource.md/.github/DEVELOPMENT.md (file was renamed/moved)

This ensures links resolve correctly regardless of rendering context while maintaining the same target files. All repository-owned documentation now has validated, working links.

Validation

  • Reviewed all 52 markdown files in the repository
  • Fixed 6 broken links across 3 files
  • Verified all remaining links are valid (except 2 intentional example links in eng/common/template-guidance.md which is managed by Arcade automation)

Fixes #32336

Original prompt

This section details on the original issue you should resolve

<issue_title>[docs] Contrubituing documentation in repo has broken links</issue_title>
<issue_description>Some of the links in the CONTRIBUTING.md file are broken and link to non-existing pages.

Among these are links to:

It looks like the markdown files have been moved to .github/ and the links were not updated or relative links in this folder don't work.

The benchmark project also seems to have moved or does not exist anymore.</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Nov 2, 2025
…aths

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix broken links in CONTRIBUTING.md file Fix broken links in CONTRIBUTING.md using repository-root-relative paths Nov 2, 2025
Copilot AI requested a review from PureWeen November 2, 2025 15:46
Copilot finished work on behalf of PureWeen November 2, 2025 15:46
@PureWeen PureWeen added this to the .NET 10 SR1 milestone Nov 2, 2025
@PureWeen PureWeen moved this from Todo to Ready To Review in MAUI SDK Ongoing Nov 2, 2025
@PureWeen PureWeen marked this pull request as ready for review November 2, 2025 16:01
Copilot AI review requested due to automatic review settings November 2, 2025 16:01
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 updates relative file paths in the CONTRIBUTING.md file to use absolute paths from the repository root, making the links work correctly from any location in the repository.

Key changes:

  • Updated markdown links to use absolute paths (starting with /) instead of relative paths
  • Ensures links to CODE_OF_CONDUCT.md, DEVELOPMENT.md, PULL_REQUEST_TEMPLATE.md, and the Benchmarks directory work consistently

@PureWeen
Copy link
Member

PureWeen commented Nov 2, 2025

@copilot can you review all of our docs (any markdown file) and validate that the links are correct?

Please fix any links that are incorrect

Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Nov 2, 2025

@copilot can you review all of our docs (any markdown file) and validate that the links are correct?

Please fix any links that are incorrect

I've completed a comprehensive review of all 52 markdown files in the repository.

Broken links found and fixed:

  • .github/copilot-instructions.md - 3 links fixed
  • docs/README.md - 1 link fixed (BuildFromSource.md → /.github/DEVELOPMENT.md)

Broken links found but NOT fixed:

  • ⚠️ eng/common/template-guidance.md - 2 broken example links to azure-pipelines.yml files
    • These should NOT be fixed as eng/common/ is managed by Arcade automation (see eng/common/README.md)

All repository-owned documentation now has valid links. Fixed in commit 3694e78.

Copilot AI changed the title Fix broken links in CONTRIBUTING.md using repository-root-relative paths Fix broken links in documentation using repository-root-relative paths Nov 2, 2025
Copilot finished work on behalf of PureWeen November 2, 2025 16:11
@jsuarezruiz
Copy link
Contributor

/azp run

@azure-pipelines
Copy link

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

@github-project-automation github-project-automation bot moved this from Ready To Review to Approved in MAUI SDK Ongoing Nov 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Approved

Development

Successfully merging this pull request may close these issues.

[docs] Contrubituing documentation in repo has broken links

3 participants