docs: document custom ChatKit and keep internal records out - #36
Merged
Merged
Conversation
25 tasks
danielblignaut
force-pushed
the
codex/custom-chatkit-providers
branch
from
September 7, 2026 20:47
d8c6fbf to
20eefaf
Compare
danielblignaut
marked this pull request as ready for review
September 7, 2026 20:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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/sdkpackages.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
.gitignoreexclusions, 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-boundarydocs/adrsanddocs/updatesfixtures.mint validatemint broken-linksmint a11ygit diff --checkPublication 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.