Skip to content

Update Obsidian documentation for version 1.1.0 - #121

Merged
SeoFood merged 1 commit into
mainfrom
seofood/update-obsidian-1-1-0
Aug 10, 2026
Merged

Update Obsidian documentation for version 1.1.0#121
SeoFood merged 1 commit into
mainfrom
seofood/update-obsidian-1-1-0

Conversation

@SeoFood

@SeoFood SeoFood commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Summary

  • update the Obsidian add-on metadata and bilingual documentation for macOS plugin version 1.1.0
  • document workflow and automatic export, note and filename templates, placeholders, YAML frontmatter, daily notes, and live sync behavior
  • add practical Markdown examples and clearly distinguish the current Windows 1.0.0 feature set
  • replace the German and English screenshots and regenerate their WebP variants

Why

The existing page still described the original 1.0.0 feature set and did not cover the templates and history live sync added by TypeWhisper macOS PR #1089.

Validation

  • git diff --check
  • npm run test:i18n
  • npm run test:unit
  • npm run build
  • locally rendered and inspected /de/addons/obsidian/ and /en/addons/obsidian/

Summary by CodeRabbit

  • Documentation
    • Updated Obsidian addon documentation to version 1.1.0.
    • Added setup guidance for macOS and Windows, including feature differences and minimum requirements.
    • Documented export workflows, Auto-Export duplicate handling, customizable filenames and note templates, metadata placeholders, and YAML frontmatter.
    • Added daily-note, Live-Sync, usage examples, and recommended configuration guidance.

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5ab72179-7b7a-4c9a-8339-4184a5d84a7a

📥 Commits

Reviewing files that changed from the base of the PR and between 792613b and f4ac4d2.

⛔ Files ignored due to path filters (2)
  • public/screenshots/de/plugins/obsidian.png is excluded by !**/*.png
  • public/screenshots/en/plugins/obsidian.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • public/screenshots/de/plugins/obsidian.webp
  • public/screenshots/en/plugins/obsidian.webp
  • src/content/addons/de/obsidian.mdx
  • src/content/addons/en/obsidian.mdx

📝 Walkthrough

Walkthrough

The Obsidian addon documentation was updated to version 1.1.0 in German and English. It now covers platform requirements, export workflows, templates, metadata, YAML frontmatter, daily notes, Live-Sync, examples, and recommended configurations.

Changes

Obsidian addon documentation

Layer / File(s) Summary
Version and export workflows
src/content/addons/de/obsidian.mdx, src/content/addons/en/obsidian.mdx
The documentation now describes version 1.1.0, platform differences, vault setup, workflow export, and Auto-Export duplicate handling.
Templates and note content
src/content/addons/de/obsidian.mdx
The documentation adds filename and note templates, metadata placeholders, Markdown examples, and YAML frontmatter configuration.
Daily notes and Live-Sync
src/content/addons/de/obsidian.mdx
The documentation adds daily-note append formats, Live-Sync behavior and limits, vault boundaries, and recommended configurations.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Poem

A rabbit reviewed each note with care,
Found templates and metadata everywhere.
Daily notes grew, sync rules aligned,
YAML hopped neatly into line.
“Version 1.1.0!” I cheer,
“Obsidian’s guide is clear!”

🚥 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 main change: updating the English and German Obsidian documentation for version 1.1.0.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch seofood/update-obsidian-1-1-0

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

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

@SeoFood
SeoFood merged commit 3f292f9 into main Aug 10, 2026
2 checks passed
@SeoFood
SeoFood deleted the seofood/update-obsidian-1-1-0 branch August 10, 2026 16:55
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.

1 participant