Skip to content

docs: document custom ChatKit and keep internal records out - #36

Merged
danielblignaut merged 5 commits into
mainfrom
codex/custom-chatkit-providers
Sep 7, 2026
Merged

danielblignaut merged 5 commits into
mainfrom
codex/custom-chatkit-providers

Conversation

@danielblignaut

@danielblignaut danielblignaut commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

Changes

Document customer-hosted ChatKit providers, including generic setup/OAuth resume, scoped runtime ingestion, session tools, rich email delivery, recovery, streaming authorization, and portable connections. The guide uses Dispatch's @trytilde/sdk packages.

Remove every existing ADR and update record from this repository, including historical records, indexes, templates, and this PR's former update file. Internal engineering records now belong only in their owning source repositories. Update AGENTS, maintenance/PR skills, README policy, and the PR template to prevent recreating them.

Add .gitignore exclusions, explicit Mintlify publication exclusions, and a publication-boundary script/workflow. Development and check scripts run the guard, which rejects either forbidden directory even when untracked or force-added.

Validation

  • npm run check:publication-boundary
  • Guard accepts a clean fixture and rejects both docs/adrs and docs/updates fixtures.
  • mint validate
  • mint broken-links
  • mint a11y
  • git diff --check

Publication and related changes

API: https://github.com/trytilde/api/pull/276. SDK: trytilde/dispatch#154.

Deploy compatible API support before enabling providers or releasing the SDK. API-backed catalog regeneration and live-platform verification remain release activities. No internal ADR/update file is retained in this docs repository; rationale and verification for this change are recorded here as explicitly requested.

@danielblignaut
danielblignaut force-pushed the codex/custom-chatkit-providers branch from d8c6fbf to 20eefaf Compare September 7, 2026 20:47
@danielblignaut danielblignaut changed the title docs(chatkit): document customer-hosted providers and lifecycle docs: document custom ChatKit and keep internal records out Sep 7, 2026
@danielblignaut
danielblignaut marked this pull request as ready for review September 7, 2026 20:55
@danielblignaut
danielblignaut merged commit afe31e8 into main Sep 7, 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