docs: document the AiInsertReveal streaming reveal extension

[ozdemircibaris]

Documents the new AiInsertReveal extension in the streaming guide: what it does, how to add it, the CSS to define the fade, and its two options (className, durationMs).

It covers the @tiptap/ai-toolkit/streaming-reveal subpath added in ueberdosis/tiptap#8109, so it should ship with that release.

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
tiptap-docs	Ready	Preview	Aug 10, 2026 9:38am

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: d63c881e-01d1-4299-8a67-fca27d03a309

📥 Commits

Reviewing files that changed from the base of the PR and between 07d0a17 and fdedcf9.

📒 Files selected for processing (1)

• src/content/ai/ai-toolkit/agents/streaming.mdx

🚧 Files skipped from review as they are similar to previous changes (1)

• src/content/ai/ai-toolkit/agents/streaming.mdx

---

📝 Walkthrough

Summary

• Updated the streaming guide to document the AiInsertReveal extension.
• Added setup steps for the @tiptap/ai-toolkit/streaming-reveal import path and required collaboration provider.
• Added @tiptap/y-tiptap to the client-side dependencies.
• Documented the CSS fade effect and reduced-motion fallback.
• Explained the className and durationMs options.
• Clarified that AiInsertReveal is view-only and does not change document content.

Walkthrough

Adds installation and usage documentation for the optional AiInsertReveal extension. The documentation covers collaboration-provider setup, view-only decorations, CSS animation, reduced-motion support, and configuration options.

Changes

Streaming reveal documentation

Layer / File(s)	Summary
Document AiInsertReveal setup and usage src/content/ai/ai-toolkit/agents/streaming.mdx	Adds the @tiptap/y-tiptap dependency and documents AiInsertReveal, its provider configuration, CSS animation, reduced-motion override, className, and durationMs options.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested labels: area: ai, area: docs, complexity: easy

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the documentation change for the AiInsertReveal streaming reveal extension.
Description check	✅ Passed	The description directly explains the documented AiInsertReveal setup, CSS behavior, options, and package subpath.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/ai/ai-toolkit/agents/streaming.mdx`:
- Around line 283-287: Align the AiInsertReveal.configure custom class example
with the accompanying CSS by either adding a matching .my-reveal selector or
explicitly instructing readers to change the CSS selector from
.ai-insert-reveal. Ensure copying the documented snippets results in the
animation applying to the configured class.
- Line 237: Update the AiInsertReveal setup example to include `@tiptap/y-tiptap`
in its install command, and make the className value consistent with the CSS
shown above by using the default class or adding matching my-reveal CSS.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: d28a549b-39a8-454b-8258-aaa25996d7ac

📥 Commits

Reviewing files that changed from the base of the PR and between 5c80cd8 and 7004096.

📒 Files selected for processing (1)

• src/content/ai/ai-toolkit/agents/streaming.mdx