Skip to content

[DO NOT SUBMIT] docs(sdk): adopt configurl Registry names - #13

Draft
fortuna wants to merge 1 commit into
mainfrom
docs/configurl-registry-rename
Draft

fortuna wants to merge 1 commit into
mainfrom
docs/configurl-registry-rename

Conversation

@fortuna

@fortuna fortuna commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

DO NOT SUBMIT until an x module release containing OutlineFoundation/outline-sdk#646 is available. Keep this PR in draft and do not merge or publish before that release.

Update “Adding Custom Components” to use configurl.Registry and NewDefaultRegistry, including the registration helper signatures, app code, terminology, and Go doc links. Explain that the registry contains separate stream-dialer, packet-dialer, and packet-listener providers. Preserve the existing component examples, compact Go formatting, and registration highlighting.

The draft pins the merged SDK revision (v0.2.3-0.20261019112345-9b46f8f0fe2e) so its instructions can be executed before release. A source comment marks the temporary pin as a release blocker.

Before submission/merge:

  • A released golang.getoutline.org/sdk/x version includes the Registry rename.
  • Replace the temporary pseudo-version with that released version and remove the release-blocker comment.
  • Re-run the article commands against the release and verify the public Go doc links for NewDefaultRegistry, Registry, and Registry.NewStreamDialer.
  • Remove “DO NOT SUBMIT” and mark this PR ready for review.

Validation: clean-reader review completed and its terminology feedback addressed; all documented commands and nine existing race-enabled example checks pass against the pinned merged revision. English/German production builds and all 17 translation checks pass. Rendered API links and registration highlighting checked; the release comment is hidden from the page.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying outline-developer-documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: b5e96f0
Status: ✅  Deploy successful!
Preview URL: https://cd4933db.outline-developer-documentation.pages.dev
Branch Preview URL: https://docs-configurl-registry-rena.outline-developer-documentation.pages.dev

View logs

This branch has not been deployed

No deployments
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