Fix dead docs/ links in packages/sdk/README.md#64
Open
toon-backlog-bot[bot] wants to merge 1 commit into
Open
Conversation
packages/sdk/README.md linked to ../../docs/protocol.md and ../../docs/sdk-guide.md, which never existed in this repo. Per CLAUDE.md, shared docs live in toon-protocol/toon-meta — replace the dead relative links with absolute links into that repo. Closes #63 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
ALLiDoizCode
approved these changes
Jul 4, 2026
ALLiDoizCode
left a comment
Contributor
There was a problem hiding this comment.
Reviewed the diff (packages/sdk/README.md + new changeset).
Checks performed:
- Confirmed via
git log --all -- docs/that nodocs/directory has ever existed in this repo, so the old../../docs/protocol.mdand../../docs/sdk-guide.mdlinks were genuinely dead. - Verified both replacement targets exist in
toon-protocol/toon-meta:docs/protocol.md(with an## ILP Address Hierarchyheading matching the preserved#ilp-address-hierarchyanchor) anddocs/sdk-guide.md. - Grepped the whole repo for other
docs/protocol.md/docs/sdk-guide.mdreferences — these were the only two occurrences, so nothing was missed. - Changeset uses the empty-frontmatter format (
---\n---), correct for a docs-only change with no package version bump, consistent with.changeset/config.json. - PR title/body accurately match the diff (2 additions/2 deletions in README, +4 new changeset file) — no metadata corrections needed.
- The
buildcheck is currently failing, but it'spackages/core/src/compose.test.ts(bootstrap peer-count assertions) — unrelated to this diff, which only touchespackages/sdk/README.mdand.changeset/. Cross-checked recent CI runs onmain: the same suite passed 56/56 on the lastmainrun, so this looks like pre-existing flakiness in that test rather than something introduced here, matching what the PR description already discloses.
No blocking issues. LGTM.
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
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.
Summary
packages/sdk/README.mdlinked to../../docs/protocol.mdand../../docs/sdk-guide.md, relative paths that have never existed in this repo.CLAUDE.md, shared docs live intoon-protocol/toon-meta, not here — replaced both dead relative links with absolute links into that repo (preserving the#ilp-address-hierarchyanchor on the protocol.md link)..changeset/issue-63-fix-sdk-readme-doc-links.md) since this is a docs-only change with no package version bump.Closes #63
Verification
grep -n '\.\./\.\./docs' packages/sdk/README.md→ no matches (was 2 before the fix).devboxis not available in this sandbox, so verification ran directly per the repo's documented commands instead of via the pinned devbox shell (noted deviation):pnpm install— succeeded.pnpm -r build— succeeded (both@toon-protocol/coreand@toon-protocol/sdk).pnpm -r test— has pre-existing failures unrelated to this change (3 inpackages/core/src/compose.test.ts, 50 inpackages/sdk/src/workflow-orchestrator.test.tsand others). Confirmed identical failures reproduce onmainwith this change stashed out, so they predate this PR and are out of scope for a docs-only fix.🤖 Generated with Claude Code