Skip to content

docs(perps): fix broken relative links in knowledge docs - #74

Open
ZayanKhan-12 wants to merge 1 commit into
MetaMask:mainfrom
ZayanKhan-12:fix/perps-knowledge-broken-links
Open

docs(perps): fix broken relative links in knowledge docs#74
ZayanKhan-12 wants to merge 1 commit into
MetaMask:mainfrom
ZayanKhan-12:fix/perps-knowledge-broken-links

Conversation

@ZayanKhan-12

Copy link
Copy Markdown

Description

Every relative markdown link in domains/perps/knowledge/ (23 links across architecture.md and feature-flags.md) was broken, from two causes dating to the import of these docs from metamask-mobile's docs/perps/:

1. Files renamed on import, links not rewritten (11 links)
The docs were imported with the perps- prefix stripped from filenames, but intra-doc links kept the old names:

  • ./perps-connection-architecture.md./connection-architecture.md (7×)
  • ./perps-screens.md./screens.md (4×)

2. Referenced files never imported (12 links)
These targets don't exist anywhere in this repo — they live only in MetaMask/metamask-mobile under docs/perps/ (verified via the GitHub contents API). Rewritten to their canonical locations:

  • ./perps-sentry-reference.md → [metamask-mobile blob URL] (3×)
  • ./perps-metametrics-reference.md → [metamask-mobile blob URL] (4×)
  • ./perps-ab-testing.md → [metamask-mobile blob URL] (2×)
  • ./hyperliquid/ → [metamask-mobile tree URL] (3×)

Not touched: the backticked docs/perps/... references in review-antipatterns.md, which appear to be intentional consumer-repo paths that resolve inside a metamask-mobile checkout.

Happy to switch the external links to repo-relative docs/perps/... paths instead if that convention is preferred for skills consumed inside metamask-mobile.

Verification

  • After the change, every remaining relative link target exists in the repo (checked mechanically)
  • All 4 external targets confirmed to exist in MetaMask/metamask-mobile docs/perps/
  • node --test test/*.test.mjs — 36/36 pass

🤖 Generated with Claude Code

All relative links in domains/perps/knowledge were broken, from two
causes dating to the import from metamask-mobile docs/perps:

- Links to perps-connection-architecture.md and perps-screens.md kept
  the original filenames, but the files were imported with the perps-
  prefix stripped. Rewritten to ./connection-architecture.md and
  ./screens.md.
- Links to perps-sentry-reference.md, perps-metametrics-reference.md,
  perps-ab-testing.md, and hyperliquid/ point at files that were never
  imported. Rewritten to their canonical locations in
  MetaMask/metamask-mobile docs/perps.

The backticked docs/perps paths in review-antipatterns.md are left
as-is: they are consumer-repo paths that resolve inside a
metamask-mobile checkout.

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

@MajorLift MajorLift left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a follow-up for ensuring knowledge files are correctly installed by @metamask/skills: #87

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