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

docs: Point users to react-fontawesome for icons #364

Merged
merged 8 commits into from
Aug 3, 2020
Merged

Conversation

jim
Copy link
Contributor

@jim jim commented Jul 29, 2020

Summary

This PR adds documentation to the README that recommends the use of react-fontawesome for projects that need icons.

I'm not sure if/what should be added to the example app. I put a page in there to make sure that the icons worked, but I can take that out if it doesn't make sense to keep since it is testing an external dependency.

Related Issues or PRs

closes #84

How To Test

  • Read through the Icons section of the docs for clarity.
  • Open the example app locally and look at the Icons page.

Screenshots

Here is the new page in the example app:

Screen Shot 2020-07-29 at 3 18 52 PM

Checklist

  • PR title conforms to conventional commits, e.g. feat: Button
  • PR includes yarn audit output if dependencies changed
  • Any new components are exported from index.ts

<h1>Icons</h1>

<p className="usa-intro">
We recommend using icons from <a href="https://www.google.com/search?client=safari&rls=en&q=react-fontawesome&ie=UTF-8&oe=UTF-8">react-fontawesome</a> for projects that need icons.
Copy link
Contributor

@suzubara suzubara Jul 29, 2020

Choose a reason for hiding this comment

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

did you mean to link to the google search results instead of react-fontawesome on github?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

LOL nope!

@haworku
Copy link
Contributor

haworku commented Jul 30, 2020

To respond to your @jim comment in the PR description - I like how you added it to the example page. It doesn't hurt to remind folks a few ways this exists. thanks!

@haworku haworku added the type: documentation Improvements or additions to documentation label Jul 30, 2020
haworku
haworku previously approved these changes Jul 30, 2020
Copy link
Contributor

@ahobson ahobson left a comment

Choose a reason for hiding this comment

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

🚀

@jim jim merged commit 3de50ef into main Aug 3, 2020
@jim jim deleted the jb-docs-icons-84 branch August 3, 2020 20:45
@haworku haworku mentioned this pull request Aug 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on Icons
4 participants