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

Fix potentially confusing documentation #4933

Closed
sachinraja opened this issue Feb 4, 2021 · 7 comments · Fixed by #4950
Closed

Fix potentially confusing documentation #4933

sachinraja opened this issue Feb 4, 2021 · 7 comments · Fixed by #4950
Assignees
Labels
docs Issues for improving or updating package documentation

Comments

@sachinraja
Copy link
Contributor

sachinraja commented Feb 4, 2021

I was trying to find how to import only one icon at a time and came across this line:
const icon = require('simple-icons/icons/simpleicons');

This is a bit confusing to read for the first time. Both simple-icons and simpleicons represent this repository and can be easily mistaken for other files, not icons. simpleicons is also plural, so it could be misinterpreted as a folder. I realize that you do not want to be opinionated, but I feel it would be much more clear to change it to an easily distinguishable brand:
const icon = require('simple-icons/icons/ford');

I believe that changing other parts of the documentation could help too, so there will not be any room for doubt.

@mondeja mondeja added the docs Issues for improving or updating package documentation label Feb 4, 2021
@mondeja
Copy link
Member

mondeja commented Feb 4, 2021

I think that we can go with any open source brand. What about using shields.io?

 const icon = require('simple-icons/icons/shields-dot-io');

Maybe including the extension or is too ugly?

 const icon = require('simple-icons/icons/shields-dot-io.js');

@sachinraja
Copy link
Contributor Author

I think shields.io is a good pick as it also shows the special case of replacing . with dot. I don't think the extension should be used as that isn't how it would normally be imported.

@PeterShaggyNoble
Copy link
Member

Given #4936, shields-dot-io may not be the best choice at the moment. I'd suggest using either github or npm instead.

@mondeja
Copy link
Member

mondeja commented Feb 4, 2021

Given #4936, shields-dot-io may not be the best choice at the moment.

I agree, but are not npm or github still being too meta as the documentation can be read from both sites?

@sachinraja
Copy link
Contributor Author

sachinraja commented Feb 4, 2021

I was thinking the same. Perhaps Jekyll or Babel? I think most icons will be fine as they'll clear up the number of times simpleicons is mentioned in the docs.

@ericcornelissen
Copy link
Contributor

ericcornelissen commented Feb 6, 2021

@xCloudzx, what do you think about the documentation for CDN usage? We could use a similar style for NodeJS.

I think shields.io is a good pick as it also shows the special case of replacing . with dot. I don't think the extension should be used as that isn't how it would normally be imported.

I think we should figure out a way to properly document how titles are converted into filenames (or slugs as we call them) anyway. I opened #4946 to start the discussion on this 🙂

@sachinraja
Copy link
Contributor Author

Yeah the CDN docs look good to me. It clearly articulates exactly where to put the icon's name alongside an example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues for improving or updating package documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants