GenSpectrum / dashboard-components

https://genspectrum.github.io/dashboard-components/

GNU Affero General Public License v3.0

2 stars 0 forks source link

Code examples: Improve code display #420

Open fengelniederhammer opened 4 months ago

fengelniederhammer commented 4 months ago

404 introduced code example in the info boxes. Make the code display nicer.

The code is important for two reasons:

to see the parameters used in the component (important for a majority of users)
how to use the component yourself (important for probably only few users)

Two suggestions:

Make the code expandable
- Advantage: don't bother most users with code that they don't want to see
- Disadvantage: parameters are hidden, too
Show the parameters in human readable form
- Advantage: Makes the parameters easy to digest for human readers
- Disadvantage: a bit more development effort.

Maybe a combination of both would also be good?

Also see this comment from the original PR: https://github.com/GenSpectrum/dashboard-components/pull/404#discussion_r1695293427