FortAwesome / Font-Awesome

The iconic SVG, font, and CSS toolkit
https://fontawesome.com
Other
73.69k stars 12.19k forks source link

A couple issues around packages #20317

Open LeaVerou opened 3 months ago

LeaVerou commented 3 months ago

1. Third-party font-awesome package pinned to 4.7.0

First, there is a font-awesome npm package which was last published …8 years ago and is still pinned to 4.7.0, an EOL version. The official npm package for FA Free is @fortawesome/fontawesome-free but font-awesome has almost as many downloads per week — 800K vs 1M! Which is understandable, that was the first name I tried as well.

It looks like it was published by @juliankrispel but they may be amenable to transferring it over or at least adding a notice to point people to the current package and running npm deprecate.

2. No README

The @fortawesome/fontawesome-free package has no README, so for users finding it via npm (and not the fontawesome.com docs), this is what they are presented with:

image

Then, they have to dig through the Code tab to figure out how to use it. Even a tiny readme with a link to the relevant docs would help a lot.

3. Website linking issues

Last, on the website, if I go to My Kits → Click on my one free kit → the page opens in the "Set Up" tab:

image

However, the "Install as a Package" button links to https://fontawesome.com/kits/<kit-id>/settings#features and at first it looked like a broken link, because I couldn't understand why it would point me there:

image

But then I spotted it:

image

Highlighting this particular option may help reduce user confusion. But also:

image

Given there is a fontawesome-free npm package, why disable the option? Presumably it means kit packages are not available for pro plans, but the way it’s worded, it makes it sound like npm packages are not available at all for free plans.

Also, the link in that option seems to be broken. It links to https://docs.fontawesome.com/web/setup/get-started#installing-and-updating-a-kit-with-a-package-manager which actually takes you to Quick Start. It looks like the correct link is https://docs.fontawesome.com/web/setup/packages ?

robmadole commented 3 months ago

Oh good catches @LeaVerou ! Thank you. There's a lot here so I'll carve this up and see what quick wins we can get. This is all pretty low effort stuff.