[Documentation] Update SVGO Usage + Repo Links #659
Merged
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
I'm updating
@svgr/cli
in a component library repo (curology/radiance-ui#1307) and noticed some stale documentation with either incorrect instructions or out-of-date links.SVGO v2 has deprecated
.yml
files in favor of.js
files (svg/svgo@b1dafc6 removed the.svgo.yml
file that was linked to, svg/svgo#1328 mentions that config file can only bejs
now, etc.), and while Github is pretty good at directing links pointing tomaster
tomain
, since this repo now usesmain
, it does not do this for.js
files converted to.ts
, and so those links are broken.This PR updates both issues to try and make the docs less broken + more helpful to users working with this library.
Test plan
N/A. It would be nice to make some of these links, both external and internal, more robust, but I don't have a good idea how to do that 🙂 🙃