Skip to content

docs: fix guide fragment links - #408

Closed
wWzZb wants to merge 1 commit into
modelcontextprotocol:mainfrom
wWzZb:codex/issue-232-doc-links
Closed

docs: fix guide fragment links#408
wWzZb wants to merge 1 commit into
modelcontextprotocol:mainfrom
wWzZb:codex/issue-232-doc-links

Conversation

@wWzZb

@wWzZb wWzZb commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

What

  • Replace three broken cross-page fragment links in docs/mcp-elements.md with canonical published guide URLs.
  • Keep the same target sections while making the links work in both GitHub Markdown and generated documentation.

Why

phpDocumentor does not resolve Markdown paths that include fragments, so the generated links disappear. Canonical absolute URLs preserve the fragments without changing the documentation layout.

Impact

Documentation-only change; no runtime behavior is affected.

Checks

  • make docs

Closes #232

@wWzZb
wWzZb marked this pull request as ready for review August 7, 2026 07:13
@chr-hertel

Copy link
Copy Markdown
Member

Unfortunately absolute links break the experience in GitHub - I think unless the upstream issue is not solved and we don't switch to RST, we'd need to switch the tooling 🤔

@chr-hertel chr-hertel added needs confirmation Needs confirmation that the PR is actually required or needed. documentation Improvements or additions to documentation labels Aug 10, 2026
@wWzZb

wWzZb commented Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

Agreed — absolute published URLs are not the right fix because they degrade the GitHub browsing experience.

I reproduced the underlying page.md#fragment failure on the latest phpDocumentor/guides main using this SDKs actual mcp-elements.mdserver-builder.md#... links. The upstream fix is phpDocumentor/guides#1300. I refreshed it onto current main, confirmed PHP 8.5 lowest dependencies and the full locked suite pass, and added regression coverage for the PHP SDK link shape. Since I cannot update the contributor branch directly, the clean mergeable refresh is at jonathanhefner/phpDocumentor-guides#2.

I am closing this workaround in favor of the upstream fix. Issue #232 should remain open until that fix is merged and available to the docs build.

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

Labels

documentation Improvements or additions to documentation needs confirmation Needs confirmation that the PR is actually required or needed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Links within markdown guides are broken

2 participants