UX issue: "Headings" are called "Titles"

Aperta
  • Qualcosa non va?
#693 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
markdown, react, typescript
Ambito
developer-experience, frontend

Direzione di ricerca

Non viene indicato alcun percorso di file né alcun test. Cerca nel codice sorgente TypeScript e nei punti di ingresso della barra degli strumenti commands.title, commands.title3 e “Titles” visibile all’utente, quindi traccia i relativi utilizzi prima di confermare la policy di compatibilità con i maintainer. Il lavoro dovrebbe essere considerato completato quando l’UI e il codice usano coerentemente “headings” e gli eventuali alias legacy vengono gestiti come concordato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
2.9k
Fork
200
Merge medio
6h 38m
PR unite (30g)
16

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di uiwjs/react-md-editor

Tutte le issue di uiwjs/react-md-editor

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.