Python: Fix/ Document Chatkit limitations clearly#2587
Merged
Conversation
…ions - Add "Requirements and Limitations" section to chatkit package README - Add "Network Requirements" and "Limitations" sections to chatkit-integration sample README - Add explanatory comments in frontend code for CDN dependency and domain key configuration Fixes #2347
…chatkit-docs-limitations
markwallace-microsoft
added
documentation
victordibia
requested review from
Copilot,
markwallace-microsoft and
moonbox3
Member
Python Test Coverage Report •
Python Unit Test Overview
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR documents previously undiscovered limitations of the ChatKit frontend library to help users understand deployment constraints in regulated and air-gapped environments.
- Added comprehensive documentation about ChatKit's CDN-only distribution and external network requirements
- Clarified domain key registration requirements for production deployments
- Added inline code comments explaining frontend dependencies and configuration
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
python/packages/chatkit/README.md |
Added "Requirements and Limitations" section documenting frontend requirements, network dependencies, and air-gapped environment constraints |
python/samples/demos/chatkit-integration/README.md |
Added "Network Requirements", "Domain Key Configuration", and "Limitations" sections with deployment prerequisites and environment restrictions |
python/samples/demos/chatkit-integration/frontend/src/App.tsx |
Added inline comments explaining domain key configuration for local vs production environments |
python/samples/demos/chatkit-integration/frontend/index.html |
Added HTML comment warning about CDN-only distribution and air-gapped environment incompatibility |
victordibia
changed the title
markwallace-microsoft
approved these changes
Dec 3, 2025
moonbox3
approved these changes
Dec 4, 2025
arisng
pushed a commit
to arisng/agent-framework
that referenced
this pull request
Feb 2, 2026
…ions (microsoft#2587) - Add "Requirements and Limitations" section to chatkit package README - Add "Network Requirements" and "Limitations" sections to chatkit-integration sample README - Add explanatory comments in frontend code for CDN dependency and domain key configuration Fixes microsoft#2347
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.
Motivation and Context
Addresses user feedback in #2347 where deploying the chatkit-integration demo in regulated/air-gapped environments revealed undocumented limitations: the ChatKit frontend (chatkit.js) is CDN-only, makes external requests to OpenAI domains, and requires domain registration for production use.
Description
Documents ChatKit frontend requirements and limitations across the relevant files:
Fixes #2347
Contribution Checklist