Skip to content

docs: fix stale API names and upgrade guidance - #410

Merged
ianmacartney merged 1 commit into
convex:mainfrom
robelest:docs/cleanup
Oct 15, 2026
Merged

ianmacartney merged 1 commit into
convex:mainfrom
robelest:docs/cleanup

Conversation

@robelest

Copy link
Copy Markdown
Collaborator

Fixes stale API names and guidance in the docs, each checked against the code and AI SDK 7: the upgrade section in CLAUDE.md (v0.7, AI SDK 7, rag 0.7.6), CONTRIBUTING build steps, createTool in rag.mdx and human-agents.mdx (inputSchema/execute, input, output), embeddingModel and embed() in context.mdx, toUIMessageStreamResponse in streaming.mdx, the UIMessage part list in messages.mdx, and what auto-deny actually does in tool-approval.mdx. Also notes that streamObject only saves once its stream is read to the end.

@robelest
robelest requested a review from ianmacartney October 15, 2026 16:47
@pkg-pr-new

pkg-pr-new Bot commented Oct 15, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@convex-dev/agent@410

commit: f9af871

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

1 issue found across 9 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="CLAUDE.md">

<violation number="1" location="CLAUDE.md:104">
P2: This leaves the v0.3.x upgrade path incomplete: the historical section starts at Step 2 after its dependency-update step was removed, while the only current install block jumps directly to v0.7/AI SDK 7. Link the historical v0.3-to-v0.6 guide here or restore the missing v0.6 dependency step.</violation>
</file>

Tip: Get a Slack DM when cubic finishes reviewing your PRs. Connect Slack

Re-trigger cubic

Comment thread CLAUDE.md

### Historical: v0.3.x (AI SDK v5) to v0.6.0 (AI SDK v6)

The remaining sections describe the older v5 to v6 upgrade. Apply them first when a project is still on v0.3.x, then continue with `MIGRATION.md`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2: This leaves the v0.3.x upgrade path incomplete: the historical section starts at Step 2 after its dependency-update step was removed, while the only current install block jumps directly to v0.7/AI SDK 7. Link the historical v0.3-to-v0.6 guide here or restore the missing v0.6 dependency step.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. When an issue isn't valid or won't be fixed in this PR, reply in its thread with the reason and then resolve the thread. At CLAUDE.md, line 104:

<comment>This leaves the v0.3.x upgrade path incomplete: the historical section starts at Step 2 after its dependency-update step was removed, while the only current install block jumps directly to v0.7/AI SDK 7. Link the historical v0.3-to-v0.6 guide here or restore the missing v0.6 dependency step.</comment>

<file context>
@@ -88,26 +88,22 @@ Follow the rules in `.cursor/rules/convex_rules.mdc`:
+
+### Historical: v0.3.x (AI SDK v5) to v0.6.0 (AI SDK v6)
+
+The remaining sections describe the older v5 to v6 upgrade. Apply them first when a project is still on v0.3.x, then continue with `MIGRATION.md`.
 
-### Step 2: Detect v5 Patterns
</file context>
Suggested change
The remaining sections describe the older v5 to v6 upgrade. Apply them first when a project is still on v0.3.x, then continue with `MIGRATION.md`.
The remaining sections describe the older v5 to v6 upgrade. For a v0.3.x project, follow the earlier migration guide linked in `MIGRATION.md` before upgrading to v0.7.

@robelest robelest Oct 15, 2026 •

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Valid, but #410 was merged before the fix landed. Restoring the v0.6 dependency step in a follow-up docs PR.

@ianmacartney
ianmacartney merged commit 1ca5176 into convex:main Oct 15, 2026
3 of 4 checks passed
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