Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Update SVGO Usage + Repo Links #659

Merged
merged 1 commit into from
Jan 1, 2022

Conversation

michaeljaltamirano
Copy link
Contributor

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 be js now, etc.), and while Github is pretty good at directing links pointing to master to main, since this repo now uses main, 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 🙂 🙃

@vercel
Copy link

vercel bot commented Dec 28, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/gregberge/svgr/CLjTHF8oMqhjUH3hGBemGWKQkuAp
✅ Preview: https://svgr-git-fork-michaeljaltamirano-docs-update-blobs-gregberge.vercel.app


Even if it is not recommended, you can also use `svgoConfig` option to specify your SVGO configuration. `svgoConfig` has precedence on `.svgo.yml`.
Even if it is not recommended, you can also use `svgoConfig` option to specify your SVGO configuration. `svgoConfig` has precedence on `svgo.config.js`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not check this for truth BTW, just assumed it was still true despite the .yml deprecation.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is.

@codecov
Copy link

codecov bot commented Dec 28, 2021

Codecov Report

Merging #659 (a1c0eb0) into main (17507b4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #659   +/-   ##
=======================================
  Coverage   92.43%   92.43%           
=======================================
  Files          32       32           
  Lines         727      727           
  Branches      239      239           
=======================================
  Hits          672      672           
  Misses         53       53           
  Partials        2        2           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 17507b4...a1c0eb0. Read the comment docs.

@gregberge gregberge merged commit 0927303 into gregberge:main Jan 1, 2022
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.

None yet

2 participants