Skip to content

docs: fix broken link to tool renaming guide in README#2316

Open
marcelsafin wants to merge 1 commit intogithub:mainfrom
marcelsafin:docs/fix-broken-tool-renaming-link
Open

docs: fix broken link to tool renaming guide in README#2316
marcelsafin wants to merge 1 commit intogithub:mainfrom
marcelsafin:docs/fix-broken-tool-renaming-link

Conversation

@marcelsafin
Copy link
Copy Markdown

Summary

Fix a broken documentation link in README.md that points to a non-existent file.

Why

README.md line 462 references docs/deprecated-tool-aliases.md which does not exist in the repository. The correct file is docs/tool-renaming.md. Clicking the link currently results in a 404.

Notably, the PR template itself (.github/pull_request_template.md line 41) already correctly links to docs/tool-renaming.md.

What changed

  • Updated the link text from "Deprecated Tool Aliases" to "Tool Renaming" to match the actual document title
  • Updated the link target from docs/deprecated-tool-aliases.md to docs/tool-renaming.md

MCP impact

  • No tool or API changes

Prompts tested (tool changes only)

N/A — documentation-only change.

Security / limits

  • No security or limits impact

Tool renaming

  • I am not renaming tools as part of this PR

Lint & tests

  • Not needed — documentation-only change, no code modified

Docs

  • Updated (README / docs / examples)

The README references docs/deprecated-tool-aliases.md which does not
exist. The correct file is docs/tool-renaming.md.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 12, 2026 16:38
@marcelsafin marcelsafin requested a review from a team as a code owner April 12, 2026 16:38
Copy link
Copy Markdown
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

Fixes a broken README documentation link by pointing the “tool renaming” note to the correct existing guide.

Changes:

  • Update README link target from docs/deprecated-tool-aliases.md (non-existent) to docs/tool-renaming.md
  • Update link text to “Tool Renaming” to match the document title

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