docs: add missing .md extensions to six cross-reference links#28505
docs: add missing .md extensions to six cross-reference links#28505ZayanKhan-12 wants to merge 1 commit into
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses broken cross-reference links within the documentation. By appending the necessary .md extensions and standardizing path formats, it ensures that users can correctly navigate between related documentation pages without encountering broken links. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
|
📊 PR Size: size/S
|
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Code Review
This pull request updates several internal documentation links in docs/hooks/reference.md and docs/reference/policy-engine.md to use correct relative paths with .md extensions instead of absolute or extensionless paths. There are no review comments, and I have no feedback to provide.
Note: Security Review has been skipped due to the limited scope of the PR.
daade18 to
63b6fb8
Compare
|
@googlebot I signed it! |
63b6fb8 to
d6862c4
Compare
policy-engine.md and hooks/reference.md link docs pages without the .md extension (and with site-absolute /docs/ paths), unlike the 57 other cross-references in these directories; on GitHub's rendered view these 404. Point them at the .md files directly. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Six cross-references in
docs/reference/policy-engine.md(5) anddocs/hooks/reference.md(1) link other doc pages extensionless — four also with site-absolute/docs/...paths — e.g.](/docs/reference/tools#available-tools)and](../reference/tools). On GitHub's rendered view these 404 (docs/reference/toolshas no extensionless file). The other 57 cross-references in the same directories consistently use relative.mdlinks, and both targets (docs/reference/tools.md,docs/tools/shell.md) exist — so this normalizes the stragglers to the dominant convention. Anchors preserved.Docs only; no code changes.
🤖 Generated with Claude Code