docs: fix broken relative links in docs - #2511
Open
Ajithkumar003-dev wants to merge 1 commit into
Open
Conversation
Five relative markdown links pointed at paths that do not exist, so they render as 404s on GitHub: - contrib/cncf/security-self-assessment.md: the Security Policy link resolved to contrib/cncf/SECURITY.md instead of the repo-root file. - contrib/cncf/technical-review.md: the licensing link resolved to contrib/cncf/LICENSE.md; the repo-root file is LICENSE, with no .md suffix. - python/packages/kagent-openai/README.md: both skills links resolved to python/kagent-skills/README.md instead of python/packages/kagent-skills/README.md. - go/core/cmd/acp-shim/sandbox/README.md: the Dockerfile link resolved to go/docker/acp-sandbox/Dockerfile, and the main.go link pointed into the sandbox directory rather than the parent acp-shim directory. Each is an off-by-one ../ depth or a wrong extension; the intended target is unambiguous in every case. The acp-shim paragraph is re-wrapped to keep the file's existing ~80 column wrapping. Docs only, no behaviour change. Signed-off-by: Ajithkumar003-dev <bhuvanaccs@gmail.com>
github-actions
Bot
added
the
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Fixes five relative markdown links that point at paths which do not exist, so they currently render as 404s on GitHub.
contrib/cncf/security-self-assessment.mdcontrib/cncf/SECURITY.mdSECURITY.mdcontrib/cncf/technical-review.mdcontrib/cncf/LICENSE.mdLICENSEpython/packages/kagent-openai/README.mdpython/kagent-skills/README.mdpython/packages/kagent-skills/README.mdgo/core/cmd/acp-shim/sandbox/README.mdgo/docker/acp-sandbox/Dockerfiledocker/acp-sandbox/Dockerfilego/core/cmd/acp-shim/sandbox/README.mdgo/core/cmd/acp-shim/sandbox/main.gogo/core/cmd/acp-shim/main.goWhy
Each one is an off-by-one
../depth or a wrong file extension, and the intended target is unambiguous in every case. Two of them are in the CNCF review documents, where the dead links happen to be the Security Policy and License rows.The
acp-shimREADME paragraph is re-wrapped across four lines rather than two because the corrected path would otherwise push it past the ~80 column wrapping the file already uses. No wording was changed.Docs only — no behaviour change.
Testing
mainthat all five old paths return 404 and all five new targets return 200.Not addressed here
Two further broken links are left alone deliberately, because the correct target can't be inferred without maintainer input:
docs/architecture/controller-reconciliation.mdanddocs/architecture/prompt-templates.mdboth link togo/core/internal/controller/agent_controller.go, which doesn't exist anywhere in the tree. The agent controller looks to have been refactored (agentharness_substrate_controller.go,sandboxagent_controller.go, thereconciler/package) — happy to follow up if someone can point me at the file that replaced it.docker/acp-sandbox/README.mdreferencestest-deployment.yamlandtest-substrate.yamlas being "in this folder", but that folder only containsDockerfileandREADME.md. That needs the manifests added, not a link edit.