Skip to content

docs: fix 7 broken relative links in CONTRIBUTING.md#7820

Open
nickvigilante wants to merge 1 commit into
mainfrom
vigilante/docs-244-fix-contributing-broken-links
Open

docs: fix 7 broken relative links in CONTRIBUTING.md#7820
nickvigilante wants to merge 1 commit into
mainfrom
vigilante/docs-244-fix-contributing-broken-links

Conversation

@nickvigilante
Copy link
Copy Markdown

Relative paths like `../test/unit` work correctly on GitHub but produce 404s when the page is rendered at `coder.com/docs/code-server/CONTRIBUTING`. The docs site treats the page URL as a directory, so relative links resolve into `/docs/code-server/...` paths that don't exist.

Replace all 7 affected links with absolute `github.com/coder/code-server/tree/main/...` URLs.

Closes https://linear.app/codercom/issue/DOCS-244

@nickvigilante nickvigilante marked this pull request as ready for review May 26, 2026 23:00
@nickvigilante nickvigilante requested a review from a team as a code owner May 26, 2026 23:00
Relative paths like ../test/unit resolve correctly on GitHub but produce
404s when the page is rendered at coder.com/docs/code-server/CONTRIBUTING.
Replace all 7 with absolute github.com/coder/code-server/tree/main/... URLs.

Closes https://linear.app/codercom/issue/DOCS-244

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@nickvigilante nickvigilante force-pushed the vigilante/docs-244-fix-contributing-broken-links branch from 747acd3 to 299e566 Compare May 26, 2026 23:00
Copy link
Copy Markdown
Member

@code-asher code-asher left a comment

Choose a reason for hiding this comment

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

Do you know if there is any way we can fix this on the docs site? Something like if the link is relative, resolve it against the repo.

Just because now it will be more difficult to jump to the other files from within an IDE, especially since they are contributing docs (it is nice to reference them within the IDE while editing without getting kicked out to a browser).

@nickvigilante
Copy link
Copy Markdown
Author

Ah, I see your point. The tricky bit will be making sure we strictly only do relative links when linking to other Markdown files, or we use absolute links for docs. I'll do some investigation on this and get back to you!

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.

2 participants