docs: phase out prominent http/https specifier examples#3006
Open
bartlomieju wants to merge 1 commit into
Open
docs: phase out prominent http/https specifier examples#3006bartlomieju wants to merge 1 commit into
bartlomieju wants to merge 1 commit into
Conversation
Reduce visibility of HTTP/HTTPS URL imports across runtime docs in favor of jsr: and npm: specifiers. Keeps a single condensed reference section in modules.md for discoverability. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
fibibot
requested changes
May 14, 2026
Contributor
fibibot
left a comment
There was a problem hiding this comment.
runtime/reference/ts_config_migration.md line 397 now shows /// <reference types="./types.d.ts" /> — identical to the example three lines above. The prose between them still reads "It can be a fully qualified URL as well:", so the second code block needs to actually be a URL (swap the deno.land/x example for an npm: or https://esm.sh/... one), or the surrounding sentence needs to be rewritten. As-is the page contradicts itself.
- nit:
runtime/fundamentals/modules.md:323keepshttps://deno.land/x/oak/mod.tsas the canonical HTTPS-imports example, but elsewhere this repo recommendsjsr:@oak/oak. A neutral CDN example would avoid the mixed signal. - nit:
runtime/reference/ts_config_migration.md:487-490still describes esm.sh'sX-TypeScript-Typesheader but now closes with "for most use cases,npm:specifiers are the recommended way" — fine, but nonpm:example is shown for the type-resolution case it was illustrating.
lunadogbot
requested changes
May 22, 2026
Contributor
lunadogbot
left a comment
There was a problem hiding this comment.
One blocker remains:
/// <reference types="./types.d.ts" />on line 397 contradicts the sentence immediately above it: the text says this example can be a fully qualified URL, but it now repeats the same relative-path example from line 389. Please restore a URL example or rewrite the sentence so the duplicate block is intentional.
- nit:
https://deno.land/x/oak/mod.tsis still the canonical HTTPS import inruntime/fundamentals/modules.md; a neutral URL would avoid the mixed signal after this PR removesdeno.land/xelsewhere.
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
jsr:andnpm:specifiersmodules.mdto a single brief reference with a caution notenpm:specifiersTest plan
modules.mdreads well as a standalone reference🤖 Generated with Claude Code