Skip to content

docs(guides): add domain setup workflows - #57

Merged
aryasaatvik merged 1 commit into
split/docs-public-api-referencefrom
split/docs-domain-setup-guides
Aug 30, 2026
Merged

docs(guides): add domain setup workflows#57
aryasaatvik merged 1 commit into
split/docs-public-api-referencefrom
split/docs-domain-setup-guides

Conversation

@aryasaatvik

Copy link
Copy Markdown
Member

Summary

  • add a runnable Effect quickstart and task-oriented setup guides
  • document provider authorization, provisioning, verification, cleanup, and host integration levels
  • add reusable docs components for provider cards and marks
  • align the package READMEs with the documented integration path
choose integration level
  -> connect provider
  -> review and apply DNS plan
  -> verify records
  -> observe lifecycle or clean up

Validation

  • executable core quickstart
  • core package build
  • isolated 28-page docs build
  • repository lint and format checks

The already-running docs development server was left untouched.

@github-actions

github-actions Bot commented Aug 30, 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

Release preview

Package Bump Version
domainkit minor 0.3.10.4.0
@domainkit/react minor 0.3.10.4.0

This PR does not add changelog files. Pending changelogs from other branches are included in the preview above.

Run bun run tegami locally to create a changelog interactively.

Managed by Tegami.

@greptile-apps

greptile-apps Bot commented Aug 30, 2026

Copy link
Copy Markdown

Greptile Summary

The PR expands DomainKit’s documentation into task-oriented workflows and aligns package READMEs with the Effect-first integration path.

  • Adds a runnable in-memory provisioning quickstart.
  • Documents host integration, provider implementation, observation, provisioning, cleanup, migration, and troubleshooting workflows.
  • Adds reusable provider-card and provider-logo documentation components.
  • Reorganizes and expands core, React, provider, and package references.

Confidence Score: 5/5

The PR appears safe to merge because no blocking failure remains in the eligible follow-up scope.

No blocking failure remains.

Important Files Changed

Filename Overview
apps/docs/content/quickstart.mdx Replaces the introductory example with a complete in-memory Effect workflow that creates, applies, and replans a DNS requirement.
packages/domainkit/examples/effect/quickstart.ts Adds the executable counterpart to the documentation quickstart using the provider and Web Crypto layers required by provisioning.
apps/docs/content/guides/host-integration.mdx Documents the server-owned identity, authorization, persistence, transport, and credential boundaries surrounding DomainKit.
apps/docs/content/guides/provision-and-clean-up.mdx Documents digest-bound plan application, durable receipts, and separately reviewed cleanup.
apps/docs/components.ts Registers the new provider-card and provider-logo components for global MDX use.
packages/domainkit/README.md Aligns package installation, entrypoint, ownership, and quickstart guidance with the expanded documentation.
packages/react/README.md Reframes the React package around complete, focused, composable, and presentation-only integration levels.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
  A[Choose integration level] --> B[Connect provider]
  B --> C[Review DNS plan]
  C --> D[Authorize exact digest]
  D --> E[Apply and persist receipt]
  E --> F[Observe DNS lifecycle]
  E --> G[Create separately authorized cleanup plan]
Loading

Reviews (8): Last reviewed commit: "docs(guides): add domain setup workflows" | Re-trigger Greptile

greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 30, 2026
@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from 30a305c to 013cce1 Compare August 30, 2026 22:49
@greptile-apps
greptile-apps Bot dismissed their stale review August 30, 2026 22:49

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

@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from 013cce1 to 8af6dab Compare August 30, 2026 22:50
greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 30, 2026
@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from 8af6dab to e4b83fe Compare August 30, 2026 22:52
@greptile-apps
greptile-apps Bot dismissed their stale review August 30, 2026 22:52

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

greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 30, 2026
@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from e4b83fe to 2e570e8 Compare August 30, 2026 22:58
@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from 2e570e8 to f45f53a Compare August 30, 2026 23:00
@greptile-apps
greptile-apps Bot dismissed their stale review August 30, 2026 23:00

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

greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 30, 2026
@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from f45f53a to 27988d9 Compare August 30, 2026 23:03
@greptile-apps
greptile-apps Bot dismissed their stale review August 30, 2026 23:03

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

greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 30, 2026
@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from 27988d9 to ad08b72 Compare August 30, 2026 23:07
@greptile-apps
greptile-apps Bot dismissed their stale review August 30, 2026 23:07

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

greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 30, 2026
@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from ad08b72 to 8c75ce9 Compare August 30, 2026 23:09
@greptile-apps
greptile-apps Bot dismissed their stale review August 30, 2026 23:09

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

greptile-apps[bot]
greptile-apps Bot previously approved these changes Aug 30, 2026
@aryasaatvik
aryasaatvik force-pushed the split/docs-domain-setup-guides branch from 8c75ce9 to 4c661ff Compare August 30, 2026 23:14
@greptile-apps
greptile-apps Bot dismissed their stale review August 30, 2026 23:14

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

@aryasaatvik
aryasaatvik merged commit b9fee22 into main Aug 30, 2026
3 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.

1 participant