docs(desktop): document deep-link URL schemes#3373
Merged
Conversation
Document the `desktop.app.deepLinks` config field for registering custom URL schemes (deno/deno#35466): per-platform bundle-time registration, scheme validation rules, and a note that in-app URL delivery lands later. Fix #3359: the full example carried a root `name` without `exports`, which triggers a `"exports" field should be specified` warning; add `exports`. Fix #3358: the `Deno.Tray` and `Deno.dock` headings were themselves markdown links, breaking the on-this-page anchors; make them plain code headings (the API links remain in the intro prose).
…ks-and-fixes # Conflicts: # runtime/desktop/tray_and_dock.md
Linking the Deno.Tray/Deno.dock headings re-broke the on-this-page anchor nav that this PR fixes (#3358). Skip heading lines in the lint instead, keeping the headings as plain code.
bartlomieju
changed the title
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
1 participant
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.
Documents the new
desktop.app.deepLinksconfiguration field fordeno desktop, which registers custom URL schemes (deep links) with the OS atbundle time. Covers the config field with single- and multi-scheme
examples, the scheme validation rules (RFC 3986 grammar, lowercasing, and
the rejected reserved schemes), and the per-platform registration
behavior on macOS, Linux, and Windows. An info callout notes that this is
OS registration only for now and that delivering an opened URL into a
running app arrives in a later release, matching the upstream PR's scope
(denoland/deno#35466).
Also folds in two reported documentation fixes on the same desktop pages.
Fixes #3359: the full configuration example carried a root
namewithoutan
exportsfield, so following it and runningdeno desktopproduced arepeated
"exports" field should be specified when specifying a "name".warning. Added
"exports": "./main.ts"to the example.Fixes #3358: the
Deno.TrayandDeno.docksection headings intray_and_dock.mdwere themselves markdown links, which broke theon-this-page anchor navigation (clicking the heading entry followed the
embedded API link instead of scrolling to the section). Changed both to
plain code headings, matching the convention on the sibling desktop
pages; the API reference links already exist in the intro prose just
above.