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

Move documentation of global query parameters to a separate page #7173

Closed
paulmelnikow opened this issue Oct 19, 2021 · 6 comments
Closed

Move documentation of global query parameters to a separate page #7173

paulmelnikow opened this issue Oct 19, 2021 · 6 comments
Labels
documentation Developer and end-user documentation frontend The React app and the infrastructure that supports it good first issue New contributors, join in!

Comments

@paulmelnikow
Copy link
Member

As suggested in #7129:

Make proper documentation pages for label options

Having everything on one page is nice, but it also feels a bit cluttered and hard to find the option you're looking for.
Putting them into a dedicated page could also give you the option of adding extra info such as examples to it to show how the options can be used.

Agree with this. I suggest we start by adding a Customization page which includes all the styles and the query options. We could create linkable anchors so it's easy to share links to the documentation when people are asking for support. include one or more rendered example where it's helpful.

In terms of process, let's make a decision about what information will go where, then mock up the page (potentially in a draft PR), and do a quick design review after that before wrapping up the code review.

@paulmelnikow paulmelnikow added frontend The React app and the infrastructure that supports it good first issue New contributors, join in! documentation Developer and end-user documentation labels Oct 19, 2021
@RobertMeissner
Copy link

Is this issue still open?

@BhaveshAnandpara
Copy link

Hey @paulmelnikow is this Issue still open ??

@YashasviChaurasia
Copy link

@paulmelnikow I would like to work on this issue.
Thank you

@itsajay1029
Copy link

Hey @paulmelnikow , can you assign me this issue so that I can get started working on it ?

@chris48s
Copy link
Member

chris48s commented Nov 8, 2022

I think this one is currently totally well defined what the output should look like. Maybe this is best considered under slightly wider (re)design thinking.

@chris48s
Copy link
Member

We have just launched a completely redesigned frontend https://shields.io/

Closing this issue as it relates to the previous frontend

The new frontend documents all the global query params on every badge builder page

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Developer and end-user documentation frontend The React app and the infrastructure that supports it good first issue New contributors, join in!
Projects
None yet
Development

No branches or pull requests

6 participants