镜像站点 · 本页由第三方 GitHub 只读镜像提供,非 GitHub 官方站点,不接受任何登录或凭据输入。前往 github.com
Skip to content

docs(chat-messages): add an agent steps example - #7256

Open
benjamincanac wants to merge 6 commits into
feat/chat-tool-errorfrom
docs/chat-agent-steps
Open

benjamincanac wants to merge 6 commits into
feat/chat-tool-errorfrom
docs/chat-agent-steps

Conversation

@benjamincanac

Copy link
Copy Markdown
Member

🔗 Linked issue

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR adds a "With agent steps" example to the ChatMessages docs. It renders an agent run from real AI SDK parts through the #part slot: a reasoning row, two commands with their output in ProsePre, a failed command with error, a "Used 2 sources" row that lists the source-url parts, and the markdown reply.

The sources row only renders on the first source-url part, the second one falls back to the default output, which renders nothing for a non-text part.

Stacked on #7253.

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@benjamincanac
benjamincanac added this pull request to stack #7257 October 21, 2026 14:56
@codspeed

codspeed Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 31 untouched benchmarks
⏩ 10 skipped benchmarks1


Comparing docs/chat-agent-steps (97bff0a) with feat/chat-tool-error (993523d)

Open in CodSpeed

Footnotes

  1. 10 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 46c3912f-f96c-48c4-8391-438bcb7d9e3c
📥 Commits

Reviewing files that changed from the base of the PR and between 6642a67 and 97bff0a.

📒 Files selected for processing: 1
  • docs/app/components/content/examples/chat/ChatMessagesAgentStepsExample.vue

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 3 remain after this review.

📝 Walkthrough

The new example defines typed user and assistant messages with reasoning, successful and failed tool results, source links, and Markdown text. It renders these parts through conditional branches in UChatMessages, groups source links into one tool card, and shows error output for failed tool calls. The chat documentation adds a forthcoming example that describes the #part slot rendering pattern.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 97bff

The documentation example has no identified issue requiring a fix before merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title describes a docs change that adds an agent steps example to the chat-messages docs. The changeset adds a new Vue example component (ChatMessagesAgentStepsExample.vue) and a documentation sec…
Description check Passed The description states that the PR adds a 'With agent steps' example to the ChatMessages docs. It explains the #part slot usage, the reasoning row, the commands with ProsePre output, the failed comman…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title describes a docs change that adds an agent steps example to the chat-messages docs. The changeset adds a new Vue example component (ChatMessagesAgentStepsExample.vue) and a documentation section marked 'Soon' in chat-messages.md, so the title matches the main change. It uses the conventional 'docs(scope):' format and is under 50 characters.

Full details: Description check

Explanation

The description states that the PR adds a 'With agent steps' example to the ChatMessages docs. It explains the #part slot usage, the reasoning row, the commands with ProsePre output, the failed command with error, the sources row, and the markdown reply. These match the raw summary of both changed files. It also notes the PR is stacked on #7253 and checks the documentation box.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated
ui Ready Ready Preview Oct 23, 2026 4:26pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
ui-repl Ignored Ignored Preview Oct 23, 2026 4:26pm UTC

Request Review

@benjamincanac benjamincanac changed the title docs(ChatMessages): add an agent steps example docs(chat-messages): add an agent steps example Oct 21, 2026
@pkg-pr-new

pkg-pr-new Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
npm i https://pkg.pr.new/@nuxt/ui@7256

commit: 97bff0a

This branch was successfully deployed

2 active (1 outdated) deployments
Preview – ui — 97bff0ad Deployed Oct 23, 2026 by vercel[bot]
Preview – ui-repl — 973eb625 Deployed Oct 23, 2026 by vercel[bot]
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.

1 participant