Skip to content

docs: add cross-links for APIs, deno.json, and std library#3003

Merged
bartlomieju merged 3 commits intomainfrom
add-api-links-test
Mar 28, 2026
Merged

docs: add cross-links for APIs, deno.json, and std library#3003
bartlomieju merged 3 commits intomainfrom
add-api-links-test

Conversation

@bartlomieju
Copy link
Copy Markdown
Member

@bartlomieju bartlomieju commented Mar 27, 2026

Summary

  • Link 59 unlinked Deno.* API references to /api/deno/~/... (fixes the api_links_test)
  • Link Web API references (fetch, Request, Response, URL, WebSocket, ReadableStream, WritableStream, TransformStream) to /api/web/~/...
  • Link first deno.json mention per CLI page to /runtime/fundamentals/configuration/
  • Link @std/* references to internal /runtime/reference/std/... pages (replacing external JSR URLs where applicable)
  • Add intro cross-links on clean, info, and update CLI pages to /runtime/fundamentals/modules/

32 files changed across runtime/fundamentals/ and runtime/reference/.

Test plan

  • deno test --allow-read api_links_test.ts passes (0 unlinked Deno API references)
  • Verify links render correctly on the docs site

🤖 Generated with Claude Code

bartlomieju and others added 3 commits March 27, 2026 17:25
Scans markdown prose in runtime/ for backtick-quoted `Deno.*` references
that aren't wrapped in a markdown link to /api/deno/~/. Prints a full
report of all occurrences with suggested fixes.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…rary

Link unlinked `Deno.*` API references to /api/deno/, Web API references
(fetch, Request, Response, URL, WebSocket, streams) to /api/web/,
first `deno.json` mentions per CLI page to /runtime/fundamentals/configuration/,
standard library references to /runtime/reference/std/, and add intro
cross-links on clean/info/update CLI pages to fundamentals/modules.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@bartlomieju bartlomieju changed the title test: lint for unlinked Deno.* API references docs: add cross-links for APIs, deno.json, and std library Mar 28, 2026
@bartlomieju bartlomieju merged commit b4eec47 into main Mar 28, 2026
2 checks passed
@bartlomieju bartlomieju deleted the add-api-links-test branch March 28, 2026 12:14
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