Skip to content

Card Builder + Agentic Card Messages#411

Open
mathews-cometchat wants to merge 5 commits into
mainfrom
feature/card-builder
Open

Card Builder + Agentic Card Messages#411
mathews-cometchat wants to merge 5 commits into
mainfrom
feature/card-builder

Conversation

@mathews-cometchat

@mathews-cometchat mathews-cometchat commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

Description

Related Issue(s)

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

@mintlify

mintlify Bot commented Jun 28, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Jun 28, 2026, 7:44 AM

@jitvarpatil

jitvarpatil commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Docs review — ✅ Approve (two nits to fix)

A large all-new docs PR (24 files, +2192/-0): a new Card Builder section plus agentic card-message pages across 8 agent frameworks, 9 image/video assets, and nav wiring. Nothing is moved or deleted, so there's no redirect/404 risk. I verified nav integrity, every cross-link and anchor, all asset refs, the shared-snippet pattern, and the formal JSON Schema — everything checks out.

✅ What passed (verified)

  • Build / nav: 0 unresolved nav refs (build-safe). All 5 card-builder + 8 ai-agents card-message pages are wired into docs.json. The leading-slash format on the ai-agents entries matches the ai-agents section's established convention (the whole tree uses leading slashes; 70 such entries repo-wide), while card-builder uses the no-slash form of its neighbors — both internally consistent.
  • Orphans: 0 new orphans (the analyzer's 38 ai-agents orphans are all pre-existing API pages; none of this PR's 13 new pages are orphaned).
  • Links & anchors: all 12 internal cross-links resolve (incl. /ai-agents/cometchat-ag-ui-byoa, /ai-agents/agent-builder/tools/overview); all 5 anchor fragments map to real headings (#6-use-variables, #8-save, #actions, #components, #variables).
  • Assets: all 9 added images/videos resolve; the 5 build-*.mp4 walkthrough videos appear in order in the worked example.
  • Shared-snippet pattern: the 8 framework pages are correctly near-identical — each imports /snippets/ai-agents/card-messages.mdx and differs only by the framework name in description.
  • Formal schema: the "Full JSON Schema" block is a valid 1,563-line JSON Schema (draft-07, parses cleanly with proper $schema/required/properties/definitions). Element-type vocabulary is consistent between elements.mdx and schema.mdx.
  • No placeholders/TODOs/lorem.

🔧 Nits to fix before merge

  • card-builder/schema.mdx (~L24 and ~L41): two ```json blocks aren't copy-paste-valid JSON — one uses a /* one or more elements */ comment, the other is a single-field fragment ("background": { … }). They're clearly illustrative, but please retag them ```jsonc (or plain ```) so they don't read as literal, runnable JSON.
  • docs.json — "Card Builder" tab is "hidden": true: reachable only via deep links (from the card-message pages and the <CardGroup> cards), not the top nav bar. Please confirm this is intentional (linked-only launch) and not an accidental leftover.

Otherwise this is excellent, well-structured work and is ready to merge once the two nits are addressed.

🤖 Automated docs review (Mintlify link/redirect/content checks + JSON-Schema validation).

The root-structure example and the colors fragment aren't copy-paste-valid JSON (one uses a /* ... */ comment, the other is a bare key-value fragment). Retag their fences from json to jsonc so they don't read as literal, runnable JSON. Addresses review nit on PR #411; Full JSON Schema block stays json.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
aaryan-rawat
aaryan-rawat previously approved these changes Jul 2, 2026
Afroz-Cometchat
Afroz-Cometchat previously approved these changes Jul 2, 2026
Internal links used a root-relative /docs/ prefix that 404s on the Mintlify site (pages live at /ai-agents/...). Strip the prefix on 7 hrefs across ai-agents.mdx and ai-agents/agent-builder/overview.mdx (5 user-facing on /ai-agents and /ai-agents/agent-builder/overview, plus 2 in a commented-out Step). Canonical and full https://.../docs/ URLs left intact.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@jitvarpatil jitvarpatil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Re-review — ✅ Approve

Both nits from the earlier review are fixed:

  • Illustrative JSON retagged: the two non-literal snippets in card-builder/schema.mdx are now ```jsonc, while the valid 1,563-line "Full JSON Schema" block stays ```json (correct).
  • Links fixed: the ai-agents card-message internal links now resolve (dropped the stray /docs prefix). Analyzer: 0 build breaks, 0 orphans, 0 broken links across both card-builder and ai-agents scopes.

Structure, nav wiring, all 9 assets, the shared-snippet pattern, and the formal JSON Schema were already verified. Ready to merge.

🤖 Automated docs review — re-check after fixes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants