UX issue: "Headings" are called "Titles"

Abierto
  • ¿Algo no está bien?
#693 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
markdown, react, typescript
Área
developer-experience, frontend

Línea de trabajo

No se especifica ninguna ruta de archivo ni ninguna prueba. Busca en el código fuente de TypeScript y en los puntos de entrada de la barra de herramientas commands.title, commands.title3 y el “Titles” visible para el usuario; después, rastrea sus usos antes de confirmar la política de compatibilidad con los mantenedores. La tarea debería considerarse terminada cuando la UI y el código usen “headings” de forma coherente, y cualquier alias heredado se gestione según lo acordado.

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

Descripción

For some reason this package and its UI consistently and erroneously refers to headings as titles.

I would like to make the case that this is a significant UX issue that should be fixed both in user-facing interfaces and in code.

Motivation (why is this an issue?)

The unfortunate naming choice is likely to cause confusion for users and developers alike.

The rest of the world uses the term "heading". If users want to learn markdown they will go to resources such as:

These resources consistently use the term heading.

Users are extremely likely to be familiar with modern word processors which also generally use the term heading for this concept.

In the context of HTML elements and attributes there is a also distinction between "heading" and "title" and this extends to tools & resources related to accessibility, search optimization, etc.

End users and developers alike may not be experts in the English language and therefore they may rely on keyword and pattern recognition to understand interfaces and make connections between what they read in documentation, markdown tutorials, etc. and what they see in @uiw/react-md-editor.

The toolbar's naming and icons are potentially confusing as well (as much as I appreciate the commitment required to produce a set of non-standard unfamiliar icons to reinforce use of the term "title" vs. using an existing open-source icon set with "heading" icons).

In the code, commands such as commands.title, commands.title3, etc. are potentially confusing to developers.

As a developer my automatic "there's a mistake!" "there's a bug!" neurons fire when I look at the code.

Thanks

I just tried this package for the first time and I appreciate the thought and work you've put in. It is refreshing to see a lighter weight option for markdown!

I also appreciate when it comes to the code this would be a breaking change to address.

One idea is you could always treat the old names as an alias to minimize impact and mark them in tsdoc comments with @deprecated.

Lenguaje dominante
TypeScript
Estrellas
2.9k
Forks
200
Merge medio
6 h 38 min
PR fusionados (30 d)
16

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 uiwjs/react-md-editor

Todos los issues de uiwjs/react-md-editor

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.