docs: document interactive chat elements and their feature flag - #404
Open
EvgeniyKvasyuk wants to merge 4 commits into
Open
docs: document interactive chat elements and their feature flag#404EvgeniyKvasyuk wants to merge 4 commits into
EvgeniyKvasyuk wants to merge 4 commits into
Conversation
PR Preview Ready!Your preview documentation is ready! Visit it here: Preview URL: http://codemie-docs-pr-previews.s3-website.eu-central-1.amazonaws.com/pr-404/ This preview will be automatically updated when you push new commits to this PR. |
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
1 participant
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.
What
Documents the interactive chat elements feature and the
features:interactiveElementscustomerflag that gates it. Nothing was documented for either before this change.
Changes
New page —
docs/user-guide/assistants/interactive-elements.mdCovers when interactive elements fit, how to enable them per assistant, how to instruct an
assistant to actually use them, what appears in chat, the element catalog, media handling,
limitations, and troubleshooting. Two screenshots taken from a running deployment.
Feature flag —
docs/admin/configuration/codemie/customer-feature-configuration.mdAdds
features:interactiveElementsto the component overview table, the Advanced Featuresconfiguration block, and the full configuration example. Also documents the gating order: the flag
is one of four conditions, so enabling it alone is not sufficient — the most frequent support
question is a correctly enabled flag with a client that cannot render the elements.
Cross-references — a pointer section in
create-assistant.md, a row in the section hubassistants/index.md, a sidebar entry, and a link back from the admin page.FAQ — two entries: how to enable the feature, and why an assistant answers in prose despite
the switch being on.
Validation
All gates run individually:
npm run lint:prettier— cleannpm run lint:markdown— 0 errorsnpm run lint:spelling— 0 issuesnpm run lint:eslint— cleannpm run typecheck— cleannpm run build— SUCCESS, no broken links; both images confirmed present in the build outputWritten in the impersonal voice required for new content by the documentation standards.