docs: link Obsidian, Obsidian Sync, and headless docs on first mention#54
Merged
Merged
Conversation
README.md and DEPLOY.md had no hyperlinks to Obsidian (the app), Obsidian Sync (the paid sync service required for the remote deploy), or the official Obsidian headless-sync documentation. Add inline links on first mention in each file, matching the convention deploy/remote/README.md already uses. Also surface Obsidian Sync explicitly in DEPLOY.md's Prerequisites list — a hard requirement previously only discoverable by reading line 5 or jumping to deploy/remote/README.md. The existing obsidian-headless-sync-docker + @Belphemur links in Acknowledgments stay as-is; only the adjacent phrase "headless Obsidian Sync" gets newly linked to obsidian.md/help/sync/headless. https://claude.ai/code/session_01K8eXF8Fe3gjCR5e2ndU2Wo
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
2 participants
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.
Summary
Adds hyperlinks for Obsidian (the app), Obsidian Sync (the paid sync service), and the official Obsidian headless-sync docs to the two top-level docs that new readers actually land on. Also surfaces Obsidian Sync explicitly in
DEPLOY.md's Prerequisites list — a hard requirement that previously was only discoverable by reading line 5 in passing or jumping over todeploy/remote/README.md.Five edits, all inline-link-on-first-mention (matching the convention
deploy/remote/README.mdalready uses at line 11):README.mdObsidian→ https://obsidian.mdREADME.mdObsidian Sync→ https://obsidian.md/syncREADME.mdheadless Obsidian Sync→ https://obsidian.md/help/sync/headlessDEPLOY.mdObsidian Sync→ https://obsidian.md/syncDEPLOY.mdObsidianvault +Obsidian SyncsubscriptionThe existing
@Belphemur+obsidian-headless-sync-dockerlinks in Acknowledgments stay untouched — only the adjacent phrase "headless Obsidian Sync" gets newly linked.Test plan
[Obsidian](https://obsidian.md)→ resolves to Obsidian homepage[Obsidian Sync](https://obsidian.md/sync)→ resolves to Obsidian Sync product page[headless Obsidian Sync](https://obsidian.md/help/sync/headless)→ resolves to official headless feature docshttps://claude.ai/code/session_01K8eXF8Fe3gjCR5e2ndU2Wo
Generated by Claude Code