-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Fix broken links in documentation using repository-root-relative paths #32338
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
base: main
Are you sure you want to change the base?
Conversation
…aths Co-authored-by: PureWeen <5375137+PureWeen@users.noreply.github.com>
There was a problem hiding this 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
|
@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>
I've completed a comprehensive review of all 52 markdown files in the repository. Broken links found and fixed:
Broken links found but NOT fixed:
All repository-owned documentation now has valid links. Fixed in commit 3694e78. |
|
/azp run |
|
Azure Pipelines could not run because the pipeline triggers exclude this branch/path. |
Links in
.github/CONTRIBUTING.mdand 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.mdDEVELOPMENT.md→/.github/DEVELOPMENT.mdPULL_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.mddocs/DevelopmentTips.md→/docs/DevelopmentTips.md.github/CONTRIBUTING.md→/.github/CONTRIBUTING.mddocs/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
eng/common/template-guidance.mdwhich is managed by Arcade automation)Fixes #32336
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.