Skip to content

Fix 404 links in v1 README to renamed example files#2822

Merged
maxisbey merged 2 commits into
mainfrom
fix-v1-readme-404-links
Jun 12, 2026
Merged

Fix 404 links in v1 README to renamed example files#2822
maxisbey merged 2 commits into
mainfrom
fix-v1-readme-404-links

Conversation

@jerome3o-anthropic

Copy link
Copy Markdown
Member

Summary

The v1 README.md (frozen on main until v2 ships) links to two example files on the main branch that were renamed as part of the FastMCPMCPServer rename, so both links now 404:

  • examples/snippets/servers/fastmcp_quickstart.py (linked directly under the Quickstart)
  • examples/fastmcp/icons_demo.py

This points both links at the v1.x branch instead, where the files still exist and match the v1 API the README documents.

No content changes to the frozen v1 docs — links only (committed with SKIP=readme-v1-frozen).

Verification

Checked every blob/main link in README.md against files on main — these were the only two missing. Confirmed both paths exist on v1.x via git ls-tree origin/v1.x.

jerome3o-anthropic and others added 2 commits June 9, 2026 14:00
The v1 README (frozen on main) links to examples/snippets/servers/
fastmcp_quickstart.py and examples/fastmcp/icons_demo.py on the main
branch, but those files were renamed there as part of the FastMCP ->
MCPServer rename, so both links now 404. Point them at the v1.x
branch, where the files still exist and match the documented v1 API.
The remaining example links still resolved on main, but the files there
were rewritten for v2 (FastMCP -> MCPServer), so they showed code that
no longer matches the v1 API this README documents. Point every example
link at v1.x, matching the two 404 fixes. The LICENSE link stays on
main; the file is identical on both branches.

Committed with SKIP=readme-v1-frozen like the previous commit.
@maxisbey maxisbey added the override-readme-freeze Deliberate edit to the frozen v1 README.md on main; skips the freeze CI check label Jun 11, 2026
@maxisbey maxisbey enabled auto-merge (squash) June 11, 2026 17:09
@maxisbey maxisbey closed this Jun 12, 2026
auto-merge was automatically disabled June 12, 2026 13:59

Pull request was closed

@maxisbey maxisbey reopened this Jun 12, 2026
@maxisbey maxisbey merged commit cf110e3 into main Jun 12, 2026
76 of 80 checks passed
@maxisbey maxisbey deleted the fix-v1-readme-404-links branch June 12, 2026 14:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

override-readme-freeze Deliberate edit to the frozen v1 README.md on main; skips the freeze CI check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants