docs: Fix occasional incorrect images in user docs & plugin store. #779
Conversation
This file contains 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
The User Guide and README.md were showing images from the main branch, whereas the docs are published from the gh-pages branch. This meant that if existing screenshots were updated on main, they would be shown in the documentation and community plugin store, prior to the new feature being released to users. For consistency, I've opted for making all images shown in this repo from the gh-pages repo, including the README. This fixes the related problem that the Obsidian Community Plugin store was showing an image of a feature that has not yet been released.
claremacrae
added
the
scope: documentation
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.
Description
The User Guide and README.md were showing images from the main branch, whereas the docs are published from the gh-pages branch.
This meant that if existing screenshots were updated on main, they would be shown in the documentation and community plugin store, prior to the new feature being released to users.
For consistency, I've opted for making all images shown in this repo from the gh-pages repo, including the README. This fixes the related problem that the Obsidian Community Plugin store was showing an image of a feature that has not yet been released.
Motivation
This fixes #778.