dbohdan / classless-css

A list of classless CSS themes/frameworks with screenshots
1.89k stars 52 forks source link

Clarify first argument of gen-screenshots.ts #32

Closed waldyrious closed 8 months ago

waldyrious commented 8 months ago

I tried to run this locally and was confused by the "name" in the script's usage message. Hopefully this change makes things more explicit and clearer for others.

dbohdan commented 8 months ago

Thanks for noticing the problem. The first argument is not quite the image filename. This shows that it really needs an explanation. The argument is the name of the framework from which the image filename is derived using the function slugify. I'll add an explanation for it soon.

dbohdan commented 8 months ago

Done in ebc4436.

waldyrious commented 8 months ago

Thanks for the clarification and quick fix! If you don't mind me asking, is there a reason the CSS file URL is not saved in data/projects.toml?

dbohdan commented 8 months ago

You're welcome!

Those URLs tend to change. Some projects do not offer a pre-built file or do not version it.

There is also the matter of creating uninformed users. A direct link to a project's CSS file would result in more people using the project without reading its website or readme. If they used it incorrectly because they didn't read the documents, it could create a wrong impression of the project, damaging its reputation, or cause additional issues to be reported to its maintainers or to me

waldyrious commented 8 months ago

Got it, thanks. I suspected it might be something along those lines.

Now, I apologize for the off-topic remark, but just to be sure: did you get a notification of my ping here? (It's fine if you did and are planning to respond later, no rush!)

dbohdan commented 8 months ago

I did. I think you get notified about a message with an @-mention even if you have unsubscribed from the thread. (I don't unsubscribe from my closed issues.)

waldyrious commented 8 months ago

That's great to hear. I did think it was the case, but was worried it might slip through the cracks since it was a closed issue :sweat_smile: Thanks for taking care of it! :pray:

dbohdan commented 8 months ago

YW!