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

[Design] Badge for applications which honor the spec #32

Open
3 tasks
Baklap4 opened this issue Sep 27, 2023 · 5 comments
Open
3 tasks

[Design] Badge for applications which honor the spec #32

Baklap4 opened this issue Sep 27, 2023 · 5 comments
Assignees

Comments

@Baklap4
Copy link
Collaborator

Baklap4 commented Sep 27, 2023

Suggestion

Create a couple of badges to show endusers what they can expect from a certain application.

I'm not a great designer myself, but i found a great generator on github which can create the certain badges easily: https://github.com/MichaelCurrin/badge-generator let's play around with it and come up with a couple of designs so we can pick the ones we like 👍

Use case

You see this a lot in the real world when applying for certain certificates (proof of validation).
Back in the days we'd show W3c Validation icons on our website to proof we are making valid html etc

https://www.w3.org/QA/Tools/Icons
image

This conveys the enduser how well the spec is adapted within the program and what he can expect to work.

Todo

  • Create badge(s)
  • Pick your poison
  • Add badges + markdown to copy on our website
@marwin89 marwin89 added this to the Project is supported roundly milestone Oct 1, 2023
@marwin89
Copy link
Collaborator

marwin89 commented Oct 4, 2023

Pre-Condition:
We need to agree first on Issue #31 and define the versions. Please check out the co-working spreadsheet for versions in Issue #31

@marwin89 marwin89 added the blocked Another task has to be finished first label Oct 4, 2023
@achimmihca
Copy link

You can just generate a static svg image via URL https://img.shields.io/badge/any%20text-you%20like-blue

Example:

  • Markdown ![format-badge](https://img.shields.io/badge/usdx%20format-v1.2.3-blue)
  • is shown as
  • format-badge

I really don't think that we need any "official" badge. We cannot enforce or verify its usage anyway.

Back in the days we'd show W3c Validation icons on our website to proof we are making valid html etc.

🤣 hard to imagine nowadays

@marwin89 marwin89 removed the blocked Another task has to be finished first label Nov 20, 2023
@codello codello mentioned this issue May 7, 2024
@marwin89 marwin89 removed this from the Project is supported roundly milestone Jan 5, 2025
@Baklap4
Copy link
Collaborator Author

Baklap4 commented Jan 22, 2025

Soo i've got a couple of suggestion badges, thanks @achimmihca for the shields.io link

Personally i'd prefer the small ones.
@marwin89 we can change the text and the blue color to something specific (hex code or color name) and we can even provide a logo.. But we don't quite have one i think? If we have one we can either base64 encode it, or supply it to https://github.com/simple-icons/simple-icons

Mostly used for versioning is the blue color so for now it is set as blue

Small ones

format-badge
format-badge
format-badge
format-badge
format-badge
format-badge

Small ones with just format

format-badge
format-badge
format-badge
format-badge
format-badge
format-badge

Example with a logo (logo needs to be uploaded to simple-icons

format-badge

Large ones

format-badge
format-badge
format-badge
format-badge
format-badge
format-badge

My idea is that the software mentions this within the README of their project. Yes we cannot enforce it but it's good to have anyways i think

Once we have tags available or versioned documentation available we can link to the exact spec.md file instead of the repository. Maybe this is something for @codello to pick up whilst @marwin89 takes care of the website to support multiversioning (#41)

@codello currently the spec.md file consists of Since, Deprecated and Removed annotations. Might be better to split the document into multiple versions so we can refer to a specific spec file instead of the general one.

@basisbit
Copy link
Member

basisbit commented Jan 22, 2025

To be honest, I am not a fan of the idea of such badges. Imho they introduce additional workload for next to no benefit, and fall into the category of feature creep.

@codello
Copy link
Contributor

codello commented Jan 22, 2025

I also don't see much value in these badges, but I'm not opposed to them. I guess it doesn't hurt to have them available and see if people want to use them. I especially like the one with the logo. If we had one with a microphone that could be cool.

@codello currently the spec.md file consists of Since, Deprecated and Removed annotations. Might be better to split the document into multiple versions so we can refer to a specific spec file instead of the general one.

Makes sense to me. I will happily create a PR for that. There are currently still a few syntax details that are marked as "not yet decided" in the spec. If it's all right with you I will over the next weeks create some issues and PRs to resolve those and then separate the spec by version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

8 participants