Skip to content
This repository has been archived by the owner on Aug 7, 2024. It is now read-only.

官网 API 文档体验优化建议 #779

Open
cptbtptpbcptdtptp opened this issue Sep 6, 2023 · 0 comments
Open

官网 API 文档体验优化建议 #779

cptbtptpbcptdtptp opened this issue Sep 6, 2023 · 0 comments
Assignees
@eyworldwide @Sway007
Labels
documentation Improvements or additions to documentation

Comments

@cptbtptpbcptdtptp
Copy link
Contributor

cptbtptpbcptdtptp commented Sep 6, 2023 •
edited
Loading

现状

  • 包含类路径
  • 包含属性名与释义
  • 可以 link 到具体属性的源码

期望

  • 缺少属性类型定义，以及属性类型的跳转
    如下图所示，Pointer 的 button 属性应该是一种枚举，deltaPosition 应该是 Vecter2，并且通过点击他们对应的类型应该可以跳转到对应的 API 文档
    image
  • API 现在与文档，示例之间的关系比较割裂，如果可以让 API ，文档，示例之间形成一个跳转矩阵，也就是说 API 文档中包含对应示例与对应文档的跳转，那我们就可以大大提升这个 API 对开发者的教育效率
  • API 的链接现在不支持跳转到某个条目
@cptbtptpbcptdtptp cptbtptpbcptdtptp added the documentation Improvements or additions to documentation label Sep 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@eyworldwide eyworldwide

@Sway007 Sway007

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@eyworldwide @Sway007 @cptbtptpbcptdtptp