docs(guides): add domain setup workflows - #57
Conversation
TegamiThis repository uses Tegami to manage releases. When your changes affect published packages, add a changelog file under Create a changelog → · Changelog format Release preview
This PR does not add changelog files. Pending changelogs from other branches are included in the preview above. Run Managed by Tegami. |
Greptile SummaryThe PR expands DomainKit’s documentation into task-oriented workflows and aligns package READMEs with the Effect-first integration path.
Confidence Score: 5/5The PR appears safe to merge because no blocking failure remains in the eligible follow-up scope. No blocking failure remains.
|
| 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]
Reviews (8): Last reviewed commit: "docs(guides): add domain setup workflows" | Re-trigger Greptile
30a305c to
013cce1
Compare
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
013cce1 to
8af6dab
Compare
8af6dab to
e4b83fe
Compare
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
e4b83fe to
2e570e8
Compare
2e570e8 to
f45f53a
Compare
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
f45f53a to
27988d9
Compare
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
27988d9 to
ad08b72
Compare
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
ad08b72 to
8c75ce9
Compare
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
8c75ce9 to
4c661ff
Compare
Dismissed because a newer commit was pushed; Greptile will re-review the current head.
Summary
Validation
The already-running docs development server was left untouched.