UX issue: "Headings" are called "Titles"

Đang mở
  • Có gì không ổn?
#693 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
markdown, react, typescript
Lĩnh vực
developer-experience, frontend

Hướng nghiên cứu

Không có đường dẫn tệp hoặc bài kiểm thử nào được nêu. Hãy tìm trong mã nguồn TypeScript và các điểm vào của toolbar các mục commands.title, commands.title3 và “Titles” hiển thị cho người dùng, sau đó lần theo các chỗ sử dụng của chúng trước khi xác nhận chính sách tương thích với các maintainer. Hoàn tất có nghĩa là UI và mã nguồn nhất quán sử dụng “headings”, đồng thời mọi bí danh legacy được xử lý theo thỏa thuận.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
TypeScript
Star
2.9k
Fork
200
Merge trung bình
6 giờ 38 phút
Pull request đã merge (30 ngày)
16

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của uiwjs/react-md-editor

Tất cả issue của uiwjs/react-md-editor

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.