Skip to content

docs(core): explain DomainKit and Domain Connect - #71

Merged
aryasaatvik merged 2 commits into
mainfrom
docs/domain-connect-explanation
Aug 31, 2026
Merged

docs(core): explain DomainKit and Domain Connect#71
aryasaatvik merged 2 commits into
mainfrom
docs/domain-connect-explanation

Conversation

@aryasaatvik

Copy link
Copy Markdown
Member

Summary

Add a Concepts page explaining how DomainKit and Domain Connect overlap, where Domain Connect is the better fit, and why provider participation and template onboarding can make an API-native lifecycle more practical.

Comparison

Domain Connect DomainKit
Primary unit Provider-supported service template Provider connection and DNS lifecycle
Write path Provider applies the template Host calls a provider adapter
State Protocol/provider flow state Plans, digests, attachments, receipts, observations
Credential boundary Provider-owned authorization Host-owned custody, consent, and persistence

Changes

  • Add /docs/core/domain-connect with fit guidance, provider-onboarding constraints, security tradeoffs, and coexistence boundaries.
  • Link the explanation from the Concepts navigation, connections guide, and docs landing page.

Validation

  • bun run build in packages/domainkit
  • bun run build in apps/docs
  • bun run reference:check
  • ./node_modules/.bin/blume validate --strict
  • bun run audit --strict
  • bun run typecheck
  • Rendered /docs/core/domain-connect locally and verified navigation and links.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 31, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
❌ Deployment failed
View logs
domainkit-docs a0c4beb Aug 31 2026, 12:12 PM

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Tegami

This repository uses Tegami to manage releases. When your changes affect published packages, add a changelog file under .tegami/ before merging.

Create a changelog → · Changelog format

No changelogs yet

This PR has no pending changelog files. If your changes require a release, add a changelog before merging.

Run bun run tegami locally to create a changelog interactively.

Managed by Tegami.

@aryasaatvik
aryasaatvik marked this pull request as ready for review August 31, 2026 12:04
@greptile-apps

greptile-apps Bot commented Aug 31, 2026

Copy link
Copy Markdown

Greptile Summary

Adds a Concepts page comparing DomainKit’s provider API lifecycle with Domain Connect’s template-based protocol.

  • Explains fit, provider participation, credential boundaries, security tradeoffs, and coexistence.
  • Links the new page from Concepts navigation, the connections guide, and the documentation landing page.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
apps/docs/content/core/domain-connect.mdx Adds the DomainKit and Domain Connect comparison, including fit guidance, operational constraints, security boundaries, and coexistence.
apps/docs/content/core/connections.mdx Adds a related-concepts link to the new Domain Connect comparison.
apps/docs/content/core/meta.ts Registers the new comparison page in the Concepts navigation.
apps/docs/content/index.mdx Adds a landing-page card linking to the new comparison page.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  UserNeed[DNS setup requirement] --> Choice{Integration model}
  Choice -->|Provider supports an onboarded template| DC[Domain Connect]
  Choice -->|Application needs an owned DNS lifecycle| DK[DomainKit]
  DC --> ProviderManaged[Provider-managed consent and template application]
  DK --> HostManaged[Host-managed credentials, planning, apply, observation, and cleanup]
Loading

Reviews (2): Last reviewed commit: "style(docs): format Domain Connect table" | Re-trigger Greptile

greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 31, 2026
@greptile-apps
greptile-apps Bot dismissed their stale review August 31, 2026 12:11

Dismissed because a newer commit was pushed; Greptile will re-review the current head.

@aryasaatvik
aryasaatvik merged commit 128eb5c into main Aug 31, 2026
3 of 4 checks passed
@aryasaatvik
aryasaatvik deleted the docs/domain-connect-explanation branch August 31, 2026 12:16
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