Skip to content

docs(sdk): add guide to custom components - #12

Merged
fortuna merged 10 commits into
mainfrom
docs/extend-configurl
Oct 15, 2026
Merged

fortuna merged 10 commits into
mainfrom
docs/extend-configurl

Conversation

@fortuna

@fortuna fortuna commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Add “Adding Custom Components” under the “Custom Components” SDK sidebar entry. The guide shows component authors how to publish a Go library in their own repository with direct constructors and Register* helpers; consuming apps import the library and register on their own configurl provider container.

The runnable example separates components/delay.go, components/timeout.go, and the consuming app's main.go. Constructors own the behavior and validation, while registration helpers parse delay:<time> and timeout:t=<time>&error=<msg>. A direct-use helper demonstrates constructing the same stack without configuration strings. The guide also covers wrapper order, encoding, registration scope, and links to the key extension APIs.

Validation:

  • Fresh review by a clean-context subagent acting as a Go developer unfamiliar with Outline: no remaining clarity or conceptual issues.
  • All documented commands executed in a fresh module using the exact three extracted files; success, timeout, reversed composition, and invalid-option outputs matched.
  • Nine race-enabled checks passed, including the extracted direct-use helper, constructor validation, deadline/cancellation behavior, composition, encoding, and registration scope.
  • English/German production builds and all 17 translation checks passed; verified rendered article title, sidebar label, code filenames, and API links.
  • Example pinned to SDK x v0.2.2 and core v0.0.22; local Go 1.25.5 and Node 24.20.0. git diff --check passed.

The optional TypeScript check has three existing Cannot find namespace 'JSX' errors in src/pages/index.tsx (lines 7, 27, 75), previously reproduced on the unchanged base revision.

Phase 1 of the configuration extension documentation project. SmartDialerOptions API changes and the Mobileproxy extension article remain separate follow-up phases.

@fortuna
fortuna marked this pull request as draft October 13, 2026 17:30
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Deploying outline-developer-documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 40222a5
Status: ✅  Deploy successful!
Preview URL: https://97ac8616.outline-developer-documentation.pages.dev
Branch Preview URL: https://docs-extend-configurl.outline-developer-documentation.pages.dev

View logs

@fortuna fortuna changed the title docs(sdk): explain how to extend configurl docs(sdk): add guide to custom components Oct 13, 2026
@fortuna
fortuna marked this pull request as ready for review October 13, 2026 20:16

@ohnorobo ohnorobo 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.

nice, thanks for adding this!

Comment thread docs/sdk/extend-configurl.md
Comment thread docs/sdk/extend-configurl.md

@angelodlfrtr angelodlfrtr 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.

Unless comments I made it is nice! Publishing the full code in a repo with the variants could be helpful too as a starting point for readers / implementers.

Comment thread docs/sdk/extend-configurl.md
Comment thread docs/sdk/extend-configurl.md
Comment thread docs/sdk/extend-configurl.md
@fortuna
fortuna merged commit 5ff94de into main Oct 15, 2026
4 checks passed
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.

3 participants