UX issue: "Headings" are called "Titles"
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- markdown, react, typescript
调研方向
未指定文件路径或测试。请在 TypeScript 源代码和工具栏入口中搜索 commands.title、commands.title3 以及面向用户的 “Titles”，然后追踪它们的使用位置，再与维护者确认兼容性策略。完成应意味着 UI 和代码统一使用 “headings”，并按约定处理所有 legacy 别名。
由索引模型根据 Issue 内容生成。
描述
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:
- https://markdownguide.offshoot.io/basic-syntax/ (this one is mentioned in the README)
- https://commonmark.org/help/
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.
- 主要语言
- TypeScript
- 星标
- 2.9k
- 派生
- 200
- 平均合并
- 6 小时 38 分钟
- 30 天内合并 PR
- 16
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
uiwjs/react-md-editor 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
uiwjs/react-md-editor#730 · 1 条评论 · 2 个 reaction ·
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 25/100
uiwjs/react-md-editor#702 ·
维护者通常 1 天内回复
-
Setting background color overwrites the textarea font color可能已有人在做 @hiyouwhatsapp 于 11 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 45/100
uiwjs/react-md-editor#701 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 35/100
uiwjs/react-md-editor#695 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 45/100
uiwjs/react-md-editor#694 ·
维护者通常 1 天内回复
查看 uiwjs/react-md-editor 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 82/100
ClickHouse/clickhouse-js#1130 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
bug claude Minor static-analysis
难度 2/5 1-3 小时 新手友好度 66/100
linagora/cozy-flagship-app#1359 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复