Repository navigation
feat(www): Studio step-by-step guides with screenshots and videos, part 2 of 4 - #2429
Merged
Merged
Conversation
The runner gains three hooks: prepare clears what an earlier take left
through the API, before sets the page up outside the recording, and after
undoes what only one walkthrough needed. Screenshots hide "is ready" notices
unless a shot is about one, and a click waits for them to close first, since
a pointer resting on a notice keeps it open.
The podcast walkthrough drafts with Claude Haiku 5.5 and switches back
afterwards: Qwen3.8 27B on OpenRouter returned empty podcast scripts three
times ("model did not return valid JSON"). The images walkthrough downloads
FLUX.2 klein 4B, which draws and edits from one download.
The demo manifest adds CISA's Known Exploited Vulnerabilities list (the
Internet Archive's copy, so its bytes stay fixed), a LibriVox recording, and
two files kept in demo-documents/files because no source serves them as they
are: the IRS Publication 5708 sample security plan filled in for a made-up
firm, and the NCSC supplier assurance questions in a made-up client's
workbook.
Make a Word document, deck or PDF; make flashcards, a quiz and a mind map; turn sources into a podcast; refine a document and open an earlier version; make and edit images; and organise sources with notes, folders and previews. The hub and the sidebar gain a Studio group, and the Studio page points 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. |
This was referenced Nov 10, 2026
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 2 of the tutorials in
plans/community-local/tutorials.md: six Studio guides at/docs/v2/guides, each a short silent video above numbered steps with a screenshot of SurfSense for every step.The hub and the sidebar gain a Studio group, and the Studio page links to the guides.
Changes to the capture tooling:
prepare,beforeandafterhooks, so a retake starts as the first take did.Stacked on #2428: the base is
feat/tutorial-guides, so this diff is the Studio part only. Retarget todevonce #2428 merges.Why
The maintainer asked for step-by-step guides and videos for everything SurfSense does. Studio is part 2 of 4, before the in-app links.
Found while capturing:
GET /workspaces/1/artifacts,/internal/models/text/window) returned 500 withsqlite3.OperationalError: database is lockedwhile Studio wrote, on this 16 GB machine.anthropic/claude-haiku-5.5, the source count breaks onto two lines ("6 / sources").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 14 guides./docs/v2/guidesand the Studio group.node scripts/guides/capture.mjs studio-documents study-materials refine-and-versions podcast images organise-sourcesfromwww, on an install the first eight walkthroughs have set up.High-level PR Summary
This PR adds part 2 of a 4-part tutorial series focused on Studio features in SurfSense's documentation. It introduces six new step-by-step guides (
/docs/v2/guides) covering how to create Word documents, study materials (flashcards/quizzes/mind maps), podcasts, image generation/editing, version management, and source organization. Each guide includes a silent video walkthrough with numbered steps and screenshots. The PR also enhances the capture tooling withprepare,before, andafterhooks for consistent retakes, improves screenshot quality by hiding notices, and adds demo files to the manifest (including CISA's vulnerability list, LibriVox recordings, and IRS/NCSC templates for testing).⏱️ Estimated Review Time: 30-90 minutes
💡 Review Order Suggestion
www/content/docs/v2/guides/meta.jsonwww/content/docs/v2/guides/index.mdxwww/content/docs/v2/studio.mdxwww/content/docs/v2/guides/studio-documents.mdxwww/content/docs/v2/guides/study-materials.mdxwww/content/docs/v2/guides/podcast.mdxwww/content/docs/v2/guides/refine-and-versions.mdxwww/content/docs/v2/guides/images.mdxwww/content/docs/v2/guides/organise-sources.mdxwww/scripts/guides/walkthroughs/studio-documents.mjswww/scripts/guides/walkthroughs/study-materials.mjswww/scripts/guides/walkthroughs/podcast.mjswww/scripts/guides/walkthroughs/refine-and-versions.mjswww/scripts/guides/walkthroughs/images.mjswww/scripts/guides/walkthroughs/organise-sources.mjswww/scripts/guides/walkthroughs/index.mjswww/scripts/guides/walkthroughs/chat-model.mjswww/scripts/guides/walkthroughs/studio.mjswww/scripts/guides/capture/walkthrough-session.mjswww/scripts/guides/capture.mjswww/scripts/guides/page/overlay.mjswww/scripts/guides/demo-documents/fetch-demo-documents.mjswww/scripts/guides/demo-documents/manifest.jsonwww/scripts/guides/demo-documents/files/Written Information Security Plan.docxwww/scripts/guides/demo-documents/files/Supplier security questionnaire.xlsxwww/public/guides/studio-documents/01-format-box.webpwww/public/guides/studio-documents/02-choose-sources.webpwww/public/guides/studio-documents/03-generating.webpwww/public/guides/studio-documents/04-word-viewer.webpwww/public/guides/studio-documents/poster.webpwww/public/guides/study-materials/01-three-at-once.webpwww/public/guides/study-materials/02-flashcard.webpwww/public/guides/study-materials/03-flashcard-answer.webpwww/public/guides/study-materials/04-quiz.webpwww/public/guides/study-materials/05-mind-map.webpwww/public/guides/study-materials/poster.webpwww/public/guides/podcast/01-brief.webpwww/public/guides/podcast/02-generating.webpwww/public/guides/podcast/03-player.webpwww/public/guides/podcast/poster.webpwww/public/guides/refine-and-versions/01-refine-box.webpwww/public/guides/refine-and-versions/02-version-2.webpwww/public/guides/refine-and-versions/03-versions.webpwww/public/guides/refine-and-versions/poster.webpwww/public/guides/images/01-image-models.webpwww/public/guides/images/02-image-edit-model.webpwww/public/guides/images/03-picture.webpwww/public/guides/images/04-edit-box.webpwww/public/guides/images/05-edited.webpwww/public/guides/images/poster.webpwww/public/guides/organise-sources/01-new-note.webpwww/public/guides/organise-sources/02-source-menu.webpwww/public/guides/organise-sources/03-move-to.webpwww/public/guides/organise-sources/04-preview.webpwww/public/guides/organise-sources/poster.webp