Skip to content

docs: retake outdated screenshots and demo GIFs - #1822

Merged
chhoumann merged 2 commits into
masterfrom
docs/refresh-screenshots
Sep 26, 2026
Merged

chhoumann merged 2 commits into
masterfrom
docs/refresh-screenshots

Conversation

@chhoumann

@chhoumann chhoumann commented Sep 26, 2026 •

Copy link
Copy Markdown
Owner

Summary

Retakes the outdated screenshots and demo GIFs in the docs, from real Obsidian 1.13.7 with the current build and a throwaway demo vault. Each choice was set up through the UI and run, so the images match the page text.

  • Builders: Template, Capture and Macro builders (the Macro ones include the fix(macro): show the rename pencil in the Macro builder title and space the Choices row #1809 rename pencil), Multi (new folder-list screenshot, plus the Edit folder modal).
  • Examples: Inbox item, Kanban board, Log book, Toggl, Readwise, Movie settings, scripts with settings, suggester.
  • GIFs: AI Assistant setup and macro (GPT-6), Zettelizer, move tagged notes, Movie, Readwise, Toggl, and a new Todoist import demo. The GitHub-hosted images for moving tagged notes and Readwise are now local files.
  • Removed: unused docs/public/img/choices/*, docs/public/img/examples/*, the issue-1642-* images, TogglManagerMacroChoice.png, and the old .jpg movie screenshot.

Text changes

  • MultiChoice: the drag-into-folder instructions were wrong (the handle is at the row's right end); tested and rewritten. The placeholder section shows the Edit folder modal.
  • AIAssistant: Setup now includes turning off Disable AI & online features and the Edit → Link... → Sync now flow; the macro GIF is explained.
  • Toggl: dropped the obsolete "Macro Choice" screenshot and its sentence.
  • Field labels updated (Template path, File name format, New note location).
  • Movie: the OMDb settings image was a plain link to a path that doesn't exist on the built site (broken on master); now an inline image.
  • Todoist: added the import GIF under "What you get".

Verification

  • pnpm run build in docs/ passes (52 pages); every new image appears in the built HTML, and the GIFs stay animated after Astro's WebP conversion.
  • Every relative Images/ link in the docs resolves to an existing file.
  • The demos ran live: GPT-6 summary, OMDb lookup, Readwise import, Toggl timer, Todoist import against a temporary demo project, Nominatim geocoding.
  • Privacy: no keys or tokens appear anywhere (a fragment scan of the diff for every key used found nothing); secrets show only as masked fields. Temporary Toggl and Todoist demo data were deleted after recording.

Previews: Template builder · Macro builder · Multi list · AI setup GIF · AI macro GIF · Todoist GIF

Release / migration impact

Docs only. No plugin code, main.js, manifest.json or versions.json changes.

Follow-up

The AI Setup GIF shows the provider editor from before #1818. I'll re-record it once the provider editor moves to a settings sub-page (item 6), since that changes the flow again.

Note

Refresh outdated screenshots and demo GIFs in docs

  • Retakes old screenshots and demo GIFs for the AI Assistant, choices, and example pages, and replaces externally hosted images with local assets under docs/src/content/docs/docs/Images
  • Rewrites setup and usage instructions to match the current UI, such as the AI prompts folder setup in AIAssistant.md, the row drag handle in MultiChoice.md, and the TogglManager user script flow in Macro_TogglManager.md
  • Adds new demo GIFs for the Todoist import, Readwise book notes, and move-tagged-notes examples, plus new screenshots for the multi-choice list, edit folder modal, and suggester file search
  • Risk: docs referencing deleted images must be verified — removed assets include moviescript_settings.jpg, TogglManagerMacroChoice.png, and all images under docs/public/img

Macroscope summarized 781b120.

Summary by CodeRabbit

  • Documentation
    • Updated AI assistant setup guidance, including prompt templates, provider models, default model selection, and capturing generated summaries in notes.
    • Clarified multi-choice setup and positioning instructions.
    • Refreshed example instructions, screenshots, captions, and demonstrations for importing tasks, managing notes, creating templates, and running macros.
    • Updated the suggester image reference.

ampagent and others added 2 commits September 26, 2026 22:57
Amp-Thread-ID: https://ampcode.com/threads/T-01a0deb1-657e-701c-a05a-98672ce4f276
Co-authored-by: Christian Bager Bach Houmann <christian@bagerbach.com>
…hots after #1809

Amp-Thread-ID: https://ampcode.com/threads/T-01a0deb1-657e-701c-a05a-98672ce4f276
Co-authored-by: Christian Bager Bach Houmann <christian@bagerbach.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-26T23:04:31.419764Z 781b120 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 3c0d2201-1eec-41c3-a0ed-0c36d9d67118

📥 Commits

Reviewing files that changed from the base of the PR and between 594b952 and 781b120.

⛔ Files ignored due to path filters (30)
  • docs/public/img/choices/capture-builder.png is excluded by !**/*.png
  • docs/public/img/choices/macro-builder.png is excluded by !**/*.png
  • docs/public/img/choices/multi-choice.png is excluded by !**/*.png
  • docs/public/img/choices/template-builder.png is excluded by !**/*.png
  • docs/public/img/examples/capture-add-task.png is excluded by !**/*.png
  • docs/public/img/issue-1642-after.png is excluded by !**/*.png
  • docs/public/img/issue-1642-before.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/AI_Assistant_Macro.gif is excluded by !**/*.gif
  • docs/src/content/docs/docs/Images/AI_Assistant_Setup.gif is excluded by !**/*.gif
  • docs/src/content/docs/docs/Images/TogglManager.gif is excluded by !**/*.gif
  • docs/src/content/docs/docs/Images/TogglManagerMacro.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/TogglManagerMacroChoice.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/choices/capture-builder.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/choices/macro-builder.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/choices/multi-choice-list.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/choices/multi-choice.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/choices/template-builder.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/examples/capture-add-task.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/examples/macro-log-book.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/examples/template-add-inbox-item.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/move_tagged_notes_demo.gif is excluded by !**/*.gif
  • docs/src/content/docs/docs/Images/moviescript.gif is excluded by !**/*.gif
  • docs/src/content/docs/docs/Images/moviescript_settings.jpg is excluded by !**/*.jpg
  • docs/src/content/docs/docs/Images/moviescript_settings.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/readwise_book_notes_demo.gif is excluded by !**/*.gif
  • docs/src/content/docs/docs/Images/readwise_template_choice.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/script_with_settings.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/suggester-file-search.png is excluded by !**/*.png
  • docs/src/content/docs/docs/Images/todoist_import_demo.gif is excluded by !**/*.gif
  • docs/src/content/docs/docs/Images/zettelizer_demo.gif is excluded by !**/*.gif
📒 Files selected for processing (10)
  • docs/src/content/docs/docs/AIAssistant.md
  • docs/src/content/docs/docs/Choices/MultiChoice.md
  • docs/src/content/docs/docs/Examples/Capture_FetchTasksFromTodoist.md
  • docs/src/content/docs/docs/Examples/Macro_LogBookToDailyJournal.md
  • docs/src/content/docs/docs/Examples/Macro_MoveNotesWithATagToAFolder.md
  • docs/src/content/docs/docs/Examples/Macro_MovieAndSeriesScript.md
  • docs/src/content/docs/docs/Examples/Macro_TogglManager.md
  • docs/src/content/docs/docs/Examples/Template_AddAnInboxItem.md
  • docs/src/content/docs/docs/Examples/Template_AutomaticBookNotesFromReadwise.md
  • docs/src/content/docs/docs/SuggesterSystem.md

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


📝 Walkthrough

Walkthrough

Documentation updates revise setup and choice instructions, clarify macro, capture, and template examples, and update screenshots, captions, and an image reference.

Changes

Documentation updates

Layer / File(s) Summary
Setup and choice guidance
docs/src/content/docs/docs/AIAssistant.md, docs/src/content/docs/docs/Choices/MultiChoice.md, docs/src/content/docs/docs/SuggesterSystem.md
AI setup steps and Multi Choice instructions are updated. The Suggester System screenshot now uses a relative path.
Macro example guides
docs/src/content/docs/docs/Examples/Macro_LogBookToDailyJournal.md, docs/src/content/docs/docs/Examples/Macro_MoveNotesWithATagToAFolder.md, docs/src/content/docs/docs/Examples/Macro_MovieAndSeriesScript.md, docs/src/content/docs/docs/Examples/Macro_TogglManager.md
Macro example instructions and images are revised. Movie script image descriptions and Toggl Manager setup instructions are also updated.
Capture and template example guides
docs/src/content/docs/docs/Examples/Capture_FetchTasksFromTodoist.md, docs/src/content/docs/docs/Examples/Template_AddAnInboxItem.md, docs/src/content/docs/docs/Examples/Template_AutomaticBookNotesFromReadwise.md
The Todoist example adds a workflow GIF. Template examples update setting labels, instructions, and screenshots.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 781b1

No actionable merge risk is established in the reviewed documentation updates, and the Toggl instructions match the supported Macro-choice workflow.

Architecture Summary

Architecture risk: 🔵 Low · up to 781b1

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 10 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/src/content/docs/docs/AIAssistant.md: The setup steps now direct users to disable the AI-and-online-features restriction, configure a provider and sync its models, and choose a default model or leave it set to Ask me. The example folder path and setup image caption were also updated.
  • observed — Modified behavior in docs/src/content/docs/docs/AIAssistant.md: Added an explanation of the Macro recording: a Summarize template passes the selected paragraph to the model, stores the reply as summary, and a Capture appends it to the active note. The image caption now describes this workflow.
  • observed — Modified behavior in docs/src/content/docs/docs/Choices/MultiChoice.md: Replaces the settings-modal image and advice to drop choices beside the multi’s drag handle with instructions to use a choice’s drag handle and drop it among the unfolded multi’s rows. The tip now describes the empty-state band and how it highlights when a drop will land inside the multi.
  • observed — Modified behavior in docs/src/content/docs/docs/Choices/MultiChoice.md: Adds steps to open Edit folder, set Placeholder, and save, plus an image of the modal’s Name, Placeholder, and Icon settings.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary changes: refreshing outdated documentation screenshots and demo GIFs.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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

A rabbit reads the setup page,
Then hops through choices, row by row.
Three tasks appear as checkboxes,
New screenshots help the examples show.
The rabbit nods and nibbles greens.

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

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying quickadd with  Cloudflare Pages  Cloudflare Pages

Latest commit: 781b120
Status: ✅  Deploy successful!
Preview URL: https://690fc88f.quickadd.pages.dev
Branch Preview URL: https://docs-refresh-screenshots.quickadd.pages.dev

View logs

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