Skip to content

docs: update chat component docs to use @inkeep/agents-ui-cloud#2789

Merged
anubra266 merged 6 commits intomainfrom
prd-6347
Mar 22, 2026
Merged

docs: update chat component docs to use @inkeep/agents-ui-cloud#2789
anubra266 merged 6 commits intomainfrom
prd-6347

Conversation

@anubra266
Copy link
Contributor

Summary

  • Replaces all @inkeep/agents-ui references with @inkeep/agents-ui-cloud across chat component docs (install instructions, imports, AutoTypeTable type references)
  • Adds @inkeep/agents-ui-cloud as a dependency in agents-docs/package.json for type resolution at build time
  • Updates package listing in upgrading guide

Closes PRD-6347

@vercel
Copy link

vercel bot commented Mar 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agents-api Ready Ready Preview, Comment Mar 21, 2026 0:34am
agents-docs Ready Ready Preview, Comment Mar 21, 2026 0:34am
agents-manage-ui Ready Ready Preview, Comment Mar 21, 2026 0:34am

Request Review

@changeset-bot
Copy link

changeset-bot bot commented Mar 20, 2026

⚠️ No Changeset found

Latest commit: 36561e2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pullfrog
Copy link
Contributor

pullfrog bot commented Mar 20, 2026

TL;DR — Renames the UI package from @inkeep/agents-ui to @inkeep/agents-ui-cloud across all chat component documentation, updating install commands, import statements, and CDN script URLs in every framework guide. AutoTypeTable type references remain on @inkeep/agents-ui because the cloud package doesn't ship dist type declarations yet.

Key changes

  • Package rename across all docs — Every user-facing @inkeep/agents-ui reference (imports, install commands, CDN URLs) is replaced with @inkeep/agents-ui-cloud across 14 MDX files spanning the upgrading guide, overview, and per-framework guides for JavaScript, Next.js, and React. The JavaScript CDN embed URL also changes from @inkeep/agents-ui-js to @inkeep/agents-ui-js-cloud.
  • AutoTypeTable types kept on original package — All AutoTypeTable component references across 12 component MDX files remain pointed at @inkeep/agents-ui and @inkeep/agents-ui/types because @inkeep/agents-ui-cloud does not yet publish .d.ts files needed for prop-table generation at build time.
  • New dependency added alongside existing oneagents-docs/package.json adds @inkeep/agents-ui-cloud at ^0.15.18 while keeping @inkeep/agents-ui for AutoTypeTable type resolution. Both resolve to 0.15.19 in the lockfile.

Before: import { InkeepChatButton } from '@inkeep/agents-ui'
After: import { InkeepChatButton } from '@inkeep/agents-ui-cloud'

Why are both packages in package.json?

The docs site uses AutoTypeTable to auto-generate prop tables from TypeScript types at build time. The cloud package (@inkeep/agents-ui-cloud) doesn't ship .d.ts files in its dist, so type resolution still needs @inkeep/agents-ui. User-facing code examples and install instructions point to the cloud package; the original package is only retained as a build-time dependency for type introspection.

upgrading.mdx · index.mdx · package.json · react/chat-button.mdx

Summary | 16 files | 6 commits | base: mainprd-6347

Pullfrog  | View workflow run | Triggered by Pullfrogpullfrog.com𝕏

@pullfrog
Copy link
Contributor

pullfrog bot commented Mar 20, 2026

TL;DR — Renames the chat component package from @inkeep/agents-ui to @inkeep/agents-ui-cloud (and @inkeep/agents-ui-js to @inkeep/agents-ui-cloud-js) across all documentation. No component API, prop, or behavioral changes — purely a package identity migration.

Key changes

  • Rename @inkeep/agents-ui@inkeep/agents-ui-cloud in all React and Next.js docs — updates install commands, import statements, dynamic imports, and <AutoTypeTable> type references across 16 MDX files
  • Rename @inkeep/agents-ui-js@inkeep/agents-ui-cloud-js in JavaScript docs — updates CDN <script> tag URLs to point to the new package on jsDelivr
  • Update shared snippets for <AutoTypeTable> type resolution — the 11 type-table references in _snippets/chat-components/ now resolve from @inkeep/agents-ui-cloud/types
  • Update upgrading guide — references the new @inkeep/agents-ui-cloud package name and npm link
  • Add @inkeep/agents-ui-cloud dependency to agents-docs — enables <AutoTypeTable> to resolve types at build time from the new package

Summary | 18 files | 2 commits | base: mainprd-6347


Package rename across chat component documentation

Before: All docs referenced @inkeep/agents-ui for React/Next.js and @inkeep/agents-ui-js for vanilla JavaScript CDN embeds.
After: Docs now reference @inkeep/agents-ui-cloud and @inkeep/agents-ui-cloud-js respectively. Component names, props, and exports are unchanged.

This is a mechanical find-and-replace touching install commands (npm install/pnpm add/yarn add), static and dynamic import statements, <AutoTypeTable> type resolution paths, and CDN script src URLs. The old @inkeep/agents-ui dependency is retained in package.json alongside the new @inkeep/agents-ui-cloud — both at ^0.15.18.

What exactly changed in each doc category?
Category Files Change
Shared snippets 2 11 <AutoTypeTable> type paths updated from @inkeep/agents-ui/types@inkeep/agents-ui-cloud/types
JavaScript docs 4 CDN URL updated to @inkeep/agents-ui-cloud-js@0.15
React docs 4 Install commands and imports updated to @inkeep/agents-ui-cloud
Next.js docs 4 Install commands, static imports, and dynamic imports updated
Index + upgrading 2 Package name and npm link updated

agents-docs/package.json · _snippets/chat-components/ai-chat-settings.mdx · content/guides/upgrading.mdx · (chat-components)/index.mdx

Pullfrog  | View workflow run | Triggered by Pullfrogpullfrog.com𝕏

claude[bot]

This comment was marked as resolved.

@github-actions github-actions bot deleted a comment from claude bot Mar 20, 2026
Copy link
Contributor

@pullfrog pullfrog bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation find-and-replace from @inkeep/agents-ui to @inkeep/agents-ui-cloud looks correct across all 16 MDX files. One blocking issue: the lockfile is missing a resolution for the newly added @inkeep/agents-ui-cloud dependency, which will cause the AutoTypeTable type references to fail during the docs build.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow runpullfrog.com𝕏

Copy link
Contributor

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Review Summary

(0) Total Issues | Risk: Low

Delta review scope: 1 commit since last review — 5772f059b fix: regenerate lockfile with @inkeep/agents-ui-cloud resolution

The lockfile fix correctly addresses the blocking issue raised by pullfrog. The new commit adds:

  • Importer entry for @inkeep/agents-ui-cloud under agents-docs
  • Package resolution for @inkeep/agents-ui-cloud@0.15.19
  • Complete snapshot entry with transitive dependencies

The resolution shows that @inkeep/agents-ui-cloud depends on @inkeep/agents-ui internally, which explains why both packages are retained in package.json.

🕐 Pending Recommendations (1)

  • 🧹 concepts.mdx:232 Pre-existing inconsistency: Architecture section still references agents-ui instead of agents-ui-cloud

✅ APPROVE

Summary: The lockfile regeneration correctly resolves @inkeep/agents-ui-cloud for the docs build. The blocking issue from the prior review is addressed. The optional consistency improvement in concepts.mdx remains as a pending suggestion from the prior review — it can be addressed in a follow-up if desired.

Reviewers (0)
Reviewer Returned Main Findings Consider While You're Here Inline Comments Pending Recs Discarded
(none dispatched — delta is lockfile-only)

Note: No domain reviewers dispatched — the delta consists solely of a lockfile regeneration to address prior feedback.

Copy link
Contributor

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Review Summary

(0) Total Issues | Risk: Low

Delta review scope: 1 commit since last review — f0d5ac8dd fix: use @inkeep/agents-ui/types in AutoTypeTable (cloud package missing dist types declarations)

Analysis

The latest commit correctly addresses a build issue: the @inkeep/agents-ui-cloud package is missing dist type declarations, so AutoTypeTable components couldn't resolve types from @inkeep/agents-ui-cloud/types. The fix reverts the 11 AutoTypeTable type paths back to @inkeep/agents-ui/types while keeping all user-facing documentation (install commands, import statements, code examples) pointed at @inkeep/agents-ui-cloud.

Final state of this PR:

Surface Package referenced Why
Install commands @inkeep/agents-ui-cloud Users install the cloud package
Import statements in examples @inkeep/agents-ui-cloud Users import from cloud package
CDN script URLs @inkeep/agents-ui-cloud-js Users use cloud CDN
AutoTypeTable type resolution (build-time) @inkeep/agents-ui Internal workaround — cloud package missing dist types

This is a reasonable workaround. Both packages are retained in package.json to support this split.

🕐 Pending Recommendations (1)

  • 🧹 concepts.mdx:232 Pre-existing inconsistency: Architecture section still references agents-ui instead of agents-ui-cloud

✅ APPROVE

Summary: Clean documentation migration complete. The AutoTypeTable workaround is pragmatic given the cloud package's missing dist type declarations — this is an internal build concern that doesn't affect the documented developer experience. The optional concepts.mdx consistency update remains as a pending suggestion from the prior review.

Reviewers (0)
Reviewer Returned Main Findings Consider While You're Here Inline Comments Pending Recs Discarded
(none dispatched — delta is mechanical workaround)

Note: No domain reviewers dispatched — the delta consists solely of a type resolution workaround for AutoTypeTable build failures.

@github-actions github-actions bot deleted a comment from claude bot Mar 20, 2026
Copy link
Contributor

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Review Summary

(0) Total Issues | Risk: Low

Delta review scope: 1 commit since last review — d2762bd83 fix: revert AutoTypeTable type= attrs to @inkeep/agents-ui (cloud package missing type declarations)

Analysis

The latest commit continues the same workaround pattern already reviewed and approved: reverting AutoTypeTable type paths from @inkeep/agents-ui-cloud back to @inkeep/agents-ui because the cloud package lacks dist type declarations needed for build-time prop table generation.

Changes in delta (12 files):
All changes are mechanical reversions of AutoTypeTable type attributes:

  • @inkeep/agents-ui-cloud@inkeep/agents-ui (component prop types)
  • @inkeep/agents-ui-cloud/types@inkeep/agents-ui/types (settings types)

Final state remains consistent:

Surface Package Rationale
Install commands @inkeep/agents-ui-cloud Users install cloud package
Import statements @inkeep/agents-ui-cloud Users import from cloud package
CDN script URLs @inkeep/agents-ui-cloud-js Users use cloud CDN
AutoTypeTable type resolution @inkeep/agents-ui Build-time workaround — cloud package missing dist types

🕐 Pending Recommendations (1)

  • 🧹 concepts.mdx:232 Pre-existing inconsistency: Architecture section still references agents-ui instead of agents-ui-cloud

✅ APPROVE

Summary: Clean continuation of the same mechanical workaround already approved. The delta contains no new logic or issues — just additional AutoTypeTable type path reversions across more component documentation files. The optional concepts.mdx consistency update remains as a pending suggestion from the initial review. 🚀

Reviewers (0)
Reviewer Returned Main Findings Consider While You're Here Inline Comments Pending Recs Discarded
(none dispatched — delta is mechanical workaround)

Note: No domain reviewers dispatched — the delta consists solely of additional AutoTypeTable type path reversions, continuing the same pattern reviewed in the prior commit.

Copy link
Contributor

@sarah-inkeep sarah-inkeep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the js package, it should be agents-ui-js-cloud instead of agents-ui-cloud-js

Copy link
Contributor

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Review Summary

(0) Total Issues | Risk: Low

Delta review scope: 1 commit since last review — 36561e284 fix: correct JS CDN package name to @inkeep/agents-ui-js-cloud

Analysis

This commit directly addresses sarah-inkeep's CHANGES_REQUESTED feedback. The JavaScript CDN package name has been corrected from @inkeep/agents-ui-cloud-js to @inkeep/agents-ui-js-cloud across all 4 JavaScript documentation files:

File Change
javascript/chat-button.mdx agents-ui-cloud-jsagents-ui-js-cloud
javascript/custom-trigger.mdx agents-ui-cloud-jsagents-ui-js-cloud
javascript/embedded-chat.mdx agents-ui-cloud-jsagents-ui-js-cloud
javascript/side-bar-chat.mdx agents-ui-cloud-jsagents-ui-js-cloud

Final state of this PR:

Surface Package Status
Install commands (React/Next.js) @inkeep/agents-ui-cloud ✓ Correct
Import statements in examples @inkeep/agents-ui-cloud ✓ Correct
CDN script URLs (JavaScript) @inkeep/agents-ui-js-cloud ✓ Fixed
AutoTypeTable type resolution @inkeep/agents-ui ✓ Workaround (cloud package missing dist types)

🕐 Pending Recommendations (1)

  • 🧹 concepts.mdx:232 Pre-existing inconsistency: Architecture section still references agents-ui instead of agents-ui-cloud

✅ APPROVE

Summary: The blocking issue from sarah-inkeep's review is now resolved — JavaScript CDN URLs correctly reference @inkeep/agents-ui-js-cloud. The PR is ready to merge. 🚀 The optional concepts.mdx consistency update remains as a pending suggestion from the initial review — it can be addressed in a follow-up if desired.

Reviewers (0)
Reviewer Returned Main Findings Consider While You're Here Inline Comments Pending Recs Discarded
(none dispatched — delta is fix-only)

Note: No domain reviewers dispatched — the delta consists solely of a naming correction (agents-ui-cloud-jsagents-ui-js-cloud) to address prior human feedback.

@github-actions github-actions bot deleted a comment from claude bot Mar 21, 2026
@anubra266 anubra266 added this pull request to the merge queue Mar 22, 2026
Merged via the queue into main with commit cf6bbb6 Mar 22, 2026
20 checks passed
@anubra266 anubra266 deleted the prd-6347 branch March 22, 2026 08:43
@github-actions
Copy link
Contributor

🔎💬 Inkeep AI search and chat service is syncing content for source 'Inkeep Agent Framework Docs'

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.

2 participants