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

Document what the slug of a brand is #4946

Closed
4 of 6 tasks
ericcornelissen opened this issue Feb 6, 2021 · 0 comments · Fixed by #5002
Closed
4 of 6 tasks

Document what the slug of a brand is #4946

ericcornelissen opened this issue Feb 6, 2021 · 0 comments · Fixed by #5002
Assignees
Labels
docs Issues for improving or updating package documentation package Pull requests or issues that affect the NPM package

Comments

@ericcornelissen
Copy link
Contributor

ericcornelissen commented Feb 6, 2021

Kind of issue

  • Improvement
  • Bug
  • Other, namely: Documentation

This issue concerns

  • The NPM Package
  • The Packagist Package
  • The CDN usage

Description

Currently it is pretty hard to find out what the slug (i.e. the SVG filename among other things) of a brand is given the title - and issues such as #2260, #4918, #4921, and #4936 won't make it any easier - so I think we should somehow document the slug for each brand.

Two things that come to my mind immediately:

  1. Show the slug on the website. The main downside here is that website users are the only group that don't need to know the slug...
  2. Generate a Markdown table with the mapping with every release. This takes some work to set up, but once it is automated it is done and we don't need to think about it any more. Also, users can use Ctrl+f to search for the brand they want.
@ericcornelissen ericcornelissen added docs Issues for improving or updating package documentation package Pull requests or issues that affect the NPM package labels Feb 6, 2021
@ericcornelissen ericcornelissen self-assigned this Feb 13, 2021
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 package Pull requests or issues that affect the NPM package
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant