Skip to content

docs: fix broken links in SDK READMEs and moss-pikachu skill - #484

Closed
thefounderluke wants to merge 2 commits into
usemoss:mainfrom
thefounderluke:docs/fix-sdk-readme-links
Closed

docs: fix broken links in SDK READMEs and moss-pikachu skill#484
thefounderluke wants to merge 2 commits into
usemoss:mainfrom
thefounderluke:docs/fix-sdk-readme-links

Conversation

@thefounderluke

@thefounderluke thefounderluke commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Pull Request Checklist

Please ensure that your PR meets the following requirements:

  • I have read the CONTRIBUTING guide.
  • I have updated the documentation (if applicable).
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have added tests that prove my fix is effective or that my feature works. — N/A, docs-only
  • New and existing unit tests pass locally with my changes. — N/A, docs-only

Description

A sweep of all 195 markdown files in the repo for relative links that don't resolve turned up a handful of broken ones. This PR fixes the four with unambiguous targets:

  • sdks/javascript/README.md: license link pointed at sdk/LICENSE.txt; the file is sdk/LICENSE (every other SDK README already links it without the extension).
  • sdks/python/sdk/README.md: the metadata-filtering example link was one directory level short (../../ instead of ../../../) — the target file exists.
  • sdks/javascript/sdk/README.md: removed the reference to samples/metadata-filtering.ts, which doesn't exist in the samples directory. (If docs(examples): add metadata filter operator snippets #438 lands its runnable metadata-filter examples under examples/javascript/metadata-filters/, this sentence could be reinstated pointing there instead — happy to do that follow-up.)
  • examples/moss-pikachu/.cursor/skills/moss-pikachu/SKILL.md: how-to.md link was one level short; the file lives at the example root.

The sweep also found references in examples/moss-pikachu (project-summary.md, contribution.md, and three sibling skill files) that don't exist anywhere in the repo — I've left those alone rather than guess at the intent.

All four fixed targets verified to exist; re-ran the link check on the changed files — zero broken relative links remain.

Review in cubic

thefounderluke and others added 2 commits July 23, 2026 18:41
- sdks/javascript/README.md: license link pointed at sdk/LICENSE.txt;
  the file is sdk/LICENSE (matches every other SDK README).
- sdks/python/sdk/README.md: metadata-filtering example link was one
  directory level short (../../ instead of ../../../).
- sdks/javascript/sdk/README.md: remove reference to
  samples/metadata-filtering.ts, which does not exist in the samples
  directory.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
../../how-to.md resolved inside .cursor/; the file lives at the
example root, three levels up.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

Codex review

No issues found.

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.

1 participant