Repository navigation
feat(www): agent, plugin and voice step-by-step guides with videos, part 3 of 4 - #2430
Merged
Merged
Conversation
Eight walkthroughs: a Word report and its next version, tracked changes on a Word source, a CSV analysed and charted in a document, PDFs merged and numbered, a page read after its site is allowed, DeepWiki's public MCP server added and approved, a LibriVox recording transcribed, and a question dictated. They run on Claude Haiku 5.5, the plan's fallback: with Qwen3.8 27B the agent called the analysis tool with nothing to analyse and stopped mid-correction. Chromium's fake microphone plays a spoken question kept in demo-documents, made with Windows' speech synthesis. A follow-up in a chat now waits for its own reply rather than the one before it, closing Settings waits for notices, and the stubbed updater answers a check as up to date. The privacy answers from setup carry from one walkthrough to the next.
…videos Have the agent write a report or a deck, edit your own Word file with tracked changes, analyse a spreadsheet and chart it, merge and number PDFs, let the agent read the web, connect a plugin, turn a recording into a source, and dictate a question. The hub and the sidebar gain Agent and plugins and Voice groups, and the Agent, Plugins and Voice pages point to the guides.
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
|
Caution Review failedThe pull request is closed.
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. |
… and lint fixes Three walkthroughs switched a host off through the egress API with the same dozen lines; setHostAllowed does it for them and for the next ones. The agent walkthroughs' useAgentModel is now switchToAgentModel: Biome's useHookAtTopLevel read the use prefix as a React hook. Also drops an unused import and an unused variable Biome flagged.
This was referenced Nov 10, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Part 3 of the tutorials in
plans/community-local/tutorials.md: eight guides for the agent, plugins and voice at/docs/v2/guides. Each is a short silent video above numbered steps, with a screenshot of SurfSense for every step.The hub and the sidebar gain Agent and plugins and Voice groups. The Agent, Plugins and Voice pages link to the guides.
Stacked on #2429; the base is
feat/tutorial-guides-studio.Why
Part 3 of 4 of the guides the maintainer asked for.
These walkthroughs run on Claude Haiku 5.5, the plan's fallback. With Qwen3.8 27B, the agent called the data-analysis tool to draw a chart with no data to analyse. It failed with "Name at least one source in document_ids", and its reply stopped mid-correction.
Found while capturing:
outputs/analysis/…/top10_vendors.png) but the chart isn't shown. The guide puts the chart in a Word document instead.searxng.surfsense.comstill returns no results (every engine "Suspended: proxy error"). The web guide reads a page the user names.Fixes # (none: asked in chat)
How to test
cd www && pnpm test:unit: 195 of 196 pass. The one failure is the video upload check.cd www && pnpm build: passes, and prerenders 22 guides./docs/v2/guidesand the Agent and plugins and Voice groups.High-level PR Summary
This PR adds part 3 of 4 of the step-by-step tutorial guides for SurfSense's documentation at
/docs/v2/guides. It introduces eight new video-based walkthroughs covering Agent and plugins (agentic chat document creation, Word file editing with tracked changes, spreadsheet analysis, PDF manipulation, web research, and MCP plugin integration) and Voice features (audio transcription and voice input). Each guide includes a silent video demonstration above numbered steps with screenshots. The guides are organized into new groups in the documentation hub and sidebar, with links added from existing Agent, Plugins, and Voice pages. The implementation includes both the MDX guide content and the underlying JavaScript test automation for capturing the walkthrough videos.⏱️ Estimated Review Time: 30-90 minutes
💡 Review Order Suggestion
www/content/docs/v2/guides/agent-documents.mdxwww/content/docs/v2/guides/tracked-changes.mdxwww/content/docs/v2/guides/analyse-a-spreadsheet.mdxwww/content/docs/v2/guides/pdf-tools.mdxwww/content/docs/v2/guides/web-research.mdxwww/content/docs/v2/guides/plugins.mdxwww/content/docs/v2/guides/transcribe-a-recording.mdxwww/content/docs/v2/guides/voice-input.mdxwww/content/docs/v2/guides/index.mdxwww/content/docs/v2/guides/meta.jsonwww/content/docs/v2/agent.mdxwww/content/docs/v2/plugins/index.mdxwww/content/docs/v2/voice.mdxwww/scripts/guides/walkthroughs/agent-documents.mjswww/scripts/guides/walkthroughs/tracked-changes.mjswww/scripts/guides/walkthroughs/analyse-a-spreadsheet.mjswww/scripts/guides/walkthroughs/pdf-tools.mjswww/scripts/guides/walkthroughs/web-research.mjswww/scripts/guides/walkthroughs/plugins.mjswww/scripts/guides/walkthroughs/transcribe-a-recording.mjswww/scripts/guides/walkthroughs/voice-input.mjswww/scripts/guides/walkthroughs/agent-chat.mjswww/scripts/guides/walkthroughs/index.mjswww/scripts/guides/walkthroughs/open-settings.mjswww/scripts/guides/capture.mjswww/scripts/guides/app/bridge.mjswww/scripts/guides/demo-documents/files/Spoken question.wavwww/scripts/guides/demo-documents/manifest.jsonwww/public/guides/agent-documents/01-working.webpwww/public/guides/agent-documents/02-reply.webpwww/public/guides/agent-documents/03-document.webpwww/public/guides/agent-documents/04-version-2.webpwww/public/guides/agent-documents/poster.webpwww/public/guides/tracked-changes/01-reply.webpwww/public/guides/tracked-changes/02-revised-copy.webpwww/public/guides/tracked-changes/03-downloads.webpwww/public/guides/tracked-changes/poster.webpwww/public/guides/analyse-a-spreadsheet/01-working.webpwww/public/guides/analyse-a-spreadsheet/02-answer.webpwww/public/guides/analyse-a-spreadsheet/03-chart-document.webpwww/public/guides/analyse-a-spreadsheet/poster.webpwww/public/guides/pdf-tools/01-steps.webpwww/public/guides/pdf-tools/02-merged-pdf.webpwww/public/guides/pdf-tools/poster.webpwww/public/guides/web-research/01-allow-site.webpwww/public/guides/web-research/02-answer.webpwww/public/guides/web-research/poster.webpwww/public/guides/plugins/01-allow-third-party.webpwww/public/guides/plugins/02-add-server.webpwww/public/guides/plugins/03-allow-server.webpwww/public/guides/plugins/04-tools.webpwww/public/guides/plugins/05-approval.webpwww/public/guides/plugins/06-answer.webpwww/public/guides/plugins/poster.webpwww/public/guides/transcribe-a-recording/01-speech-models.webpwww/public/guides/transcribe-a-recording/02-transcribing.webpwww/public/guides/transcribe-a-recording/03-cited-recording.webpwww/public/guides/transcribe-a-recording/poster.webpwww/public/guides/voice-input/01-dictating.webpwww/public/guides/voice-input/02-inserted.webpwww/public/guides/voice-input/poster.webp