Version indicator for rendered examples

Abierto
#4,533 1 comentario 4 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
react

Línea de trabajo

Empieza comparando las URL de ejemplo enlazadas de Date Time Picker Lit, React y Flow con el ejemplo incrustado, el selector „Show code“ y la acción „Open in a new tab“. El trabajo estará terminado cuando los usuarios puedan identificar la versión renderizada en los ejemplos incrustado y abierto, entender cuándo difiere de su selección y ver qué versiones están disponibles.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

#4400 changed the Docs to always render the React example if available, regardless of the selected source code type. This causes some issues.

  • Currently it isn't indicated to the users in any way that the rendered example doesn't match the source code selection.
  • You can still view e.g. the Flow example by clicking the "Open in a new tab" button at the corner when you have Flow selected for displaying the source code, but it likewise isn't indicated in any way that this is necessary, or that it possibly opens something else than what you already see.
  • If you do open to a new tab, what you see there doesn't indicate which version it belongs to either, or whether it matches what you saw in the embedded version. You can't easily decipher this from the new URL either.
  • You can't even see the version selection without first clicking 'Show code', so you might be initially looking at an embedded React example and accidentally open a Lit example to a new tab when you are actually trying to check out how the feature behaves in Flow.
  • Presumably if one of these versions didn't exist at all, it would open some other version in the new tab without the user being none the wiser.

E.g. the first example about Date Time Picker component currently links to these pages: Lit, React, Flow

The Lit URL above doesn't even mention Lit, and the Flow URL doesn't mention Flow but it does mention React even if it's apparently still the Flow example in reality.

Obviously none of this is very ideal and it's confusing to users and staff members both.

  • It would be nice to have some small indicator in the embedded example already on what version is rendered there -- if I understood correctly it's not even always React, it might still be Lit or Flow of there is no React version available. This indicator could be e.g. an icon or a letter.

    • Bonus points if there would be an info button or a tooltip or something else that explains what the indicator means -- and, if that's indeed the case, why the displayed version doesn't match the selected version in the code examples. If this explanation is very long, it could link to some FAQ instead.
  • It would also be nice to have some small indicator in the opened tab on which version was actually opened there.

    • Bonus points if the indicator could be clickable to expand a version list that would indicate which other versions are actually available and redirect you there upon selection.

If you think this issue is important, add a 👍 reaction to help the community and maintainers prioritize this issue.

Lenguaje dominante
AsciiDoc
Estrellas
38
Forks
225
Merge medio
17 h 38 min
PR fusionados (30 d)
214

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de vaadin/docs

Todos los issues de vaadin/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.