Skip to content

docs: re-record the AI Assistant setup GIF on the new settings pages - #1825

Merged
chhoumann merged 2 commits into
masterfrom
docs/ai-setup-gif
Sep 27, 2026
Merged

chhoumann merged 2 commits into
masterfrom
docs/ai-setup-gif

Conversation

@chhoumann

@chhoumann chhoumann commented Sep 27, 2026 •

Copy link
Copy Markdown
Owner

The AI Setup GIF from #1822 showed the stacked modals that #1824 replaced. Re-recorded in real Obsidian 1.13.7 from current master, following the updated Setup steps: turn off Disable AI & online features, open AI Assistant, set Prompt template folder, open OpenAI, link the API key secret with Link..., Test connection (✓, 64 models), go back, and choose gpt-6-luna as Default model. Sync now (added after review, per step 4; status shows "Last synced just now").

Verification: afterwards, settings show AI enabled, key linked, folder AI prompts, default model gpt-6-luna. The key only appears masked, and the secret list in the vault holds nothing but the demo key name. Docs only, no plugin changes.

Note

Update the AI Assistant setup GIF and its alt text for the new settings pages

Replaces the old setup GIF in the AI Assistant docs with a re-recorded version that matches the new settings pages. Also updates the image's alternative text to walk through enabling AI features, setting the prompt template folder and OpenAI API key, testing the connection, syncing models, and picking a default model.

Macroscope summarized 6c24e9f.

Summary by CodeRabbit

  • Documentation
    • Updated the setup animation’s alternative text to clarify that model syncing follows a successful OpenAI API key connection test, helping describe the setup steps shown.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 27, 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-27T00:57:26.173407Z da3200f 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 27, 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: 202ea4f1-e54c-421a-8257-35da9bf355fc

📥 Commits

Reviewing files that changed from the base of the PR and between da3200f and 6c24e9f.

⛔ Files ignored due to path filters (1)
  • docs/src/content/docs/docs/Images/AI_Assistant_Setup.gif is excluded by !**/*.gif
📒 Files selected for processing (1)
  • docs/src/content/docs/docs/AIAssistant.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/src/content/docs/docs/AIAssistant.md

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


📝 Walkthrough

Walkthrough

The setup GIF’s alternative text now mentions syncing models after testing the OpenAI API key connection.

Changes

AI Assistant documentation

Layer / File(s) Summary
Update setup GIF alt text
docs/src/content/docs/docs/AIAssistant.md
The setup GIF’s alternative text now mentions syncing models after testing the OpenAI API key connection.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 6c24e

No confirmed issue blocks merging. The GIF’s accessibility description should be checked against the final recording.

Architecture Summary

Architecture risk: 🔵 Low · up to da320

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; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/src/content/docs/docs/AIAssistant.md: Updated the setup GIF’s alt text: it now mentions opening the AI Assistant page and testing the connection, and no longer mentions syncing models.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the primary objective: re-recording the AI Assistant setup GIF for the new settings pages.
✨ 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 guide,
The GIF has words beside its side.
Test the key, then models sync,
The rabbit gives a pleased nose-wrink.
One small line now tells the tale.

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

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

Deploying quickadd with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6c24e9f
Status: ✅  Deploy successful!
Preview URL: https://1ca73177.quickadd.pages.dev
Branch Preview URL: https://docs-ai-setup-gif.quickadd.pages.dev

View logs

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: da3200f63a

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/src/content/docs/docs/AIAssistant.md Outdated
@chhoumann
chhoumann merged commit ab33ce7 into master Sep 27, 2026
13 of 15 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