docs: Improve Widget Builder and UI Kit Builder documentation#228
Open
docs: Improve Widget Builder and UI Kit Builder documentation#228
Conversation
- Add Quick Reference blocks to all 21 MDX files for AI agents and developers - Add frontmatter descriptions where missing - Replace bullet-list Next Steps with CardGroup navigation - Add JavaScript tabs alongside TypeScript tabs in code examples - Add security warnings for Auth Key usage on integration pages - Fix placeholder values (empty strings → descriptive placeholders) - Add cross-links between related documentation pages - Standardize tab naming (filename-based → language names) Files modified: - Widget Builder: widget/overview.mdx, widget/html/*.mdx, widget/html/legacy/*.mdx - UI Kit Builder React: chat-builder/react/*.mdx - UI Kit Builder Next.js: chat-builder/nextjs/*.mdx - UI Kit Builder React Router: chat-builder/react-router/*.mdx - Shared snippet: snippets/widget/overview.mdx
- Updated workflow from 6 steps to 5 steps (combined Export and Review) - Added Review Your Export section with feature toggle explanation - Added screenshot for the export modal (Step 1 of 3) - Applied to React, Next.js, and React Router integration pages
… to Troubleshooting
… simplified How It Works, and Get Started CTA
…ure with Theming and Localization cards
…ine file trees and customization tips
…te card titles to 'Customizations'
…Router integration
…ilder-customisations
…ns, labels, and reordered sections
- Converted all tables to Format D: Label (propertyName) in Setting column - Added concise What It Does descriptions matching React reference - Added boolean pattern Tip above Chat Features section - Renamed Moderator Controls to Moderation - Reordered Moderation: Blocked message feedback, Report Message, Kick, Ban, Promote/Demote - Renamed Color to Colors - Updated Settings Overview JSON: correct defaults, removed noCode and agent objects
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.
Summary
Comprehensive documentation improvements across UI Kit Builder (React, Next.js, React Router) and Widget Builder (HTML, WordPress, Shopify, Wix, Squarespace, Webflow) pages.
UI Kit Builder Changes
Overview Pages (
chat-builder/*/overview.mdx)Integration Pages (
chat-builder/*/integration.mdx)Builder Settings (
chat-builder/*/builder-settings.mdx)Typing indicator (typingIndicator))<Tip>explaining boolean pattern above Chat Features sectionmoderation) from Core Messaging to Moderation section with corrected label and descriptionBuilder Customisations (
chat-builder/*/builder-customisations.mdx)"use client"directiveDirectory Structure (
chat-builder/*/builder-dir-structure.mdx)Sidebar Navigation (
docs.json)Widget Builder Changes
Overview Pages (
widget/*/overview.mdx)Shared Widget Snippet (
snippets/widget/overview.mdx)HTML Integration (
widget/html/integration.mdx→widget/html/advanced.mdx)lines highlight={...}syntax from code blocksOther Widget Changes
widget/html/legacy/— Reorganized legacy HTML docswidget/wordpress/legacy/— Reorganized legacy WordPress docswidget/legacy/custom-build.mdx— Added legacy custom build pagewidget/squarespace/integration.mdx— Updated integration pageOther Changes
index.mdx— Homepage improvementsai-agents.mdx,ai-agents/agent-builder/overview.mdx— Minor updateschat-call.mdx,notifications.mdx— Minor updatesfundamentals/webhooks-legacy-*.mdx— Split webhooks legacy into separate pagesmoderation/legacy-extensions.mdx— Minor fixcreate-app.png,customize-no-code-widget.png,integrate-no-code.png,review-your-code.png,sign-up.pngui-kit-builder-review-export.pngFiles Changed
51 files changed across UI Kit Builder, Widget Builder, navigation, and supporting pages.