Docs - fixes README image link #2180
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2180 +/- ##
=======================================
Coverage 82.07% 82.07%
=======================================
Files 18 18
Lines 1545 1545
Branches 443 443
=======================================
Hits 1268 1268
Misses 179 179
Partials 98 98 ☔ View full report in Codecov by Sentry. |
filmaj
approved these changes
Aug 1, 2024
This was referenced Sep 5, 2024
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.
Summary
The Repo README uses a
/docsimage. This updates the path that changed when the site switched to using Docusaurus.It uses the full link for display in npm. The GitHub README wasn't reading in the .svg size adjustment when given the full link via markdown, so used HTML and sized it manually. (Same size as in .svg file).
Tested it work by previewing the README with the changes in browser
Requirements