galacean.github.io icon indicating copy to clipboard operation
galacean.github.io copied to clipboard

Published 20 hours ago • verified publisher icon galacean

官网 API 文档体验优化建议

Open cptbtptpbcptdtptp opened this issue 1 year ago • 0 comments

现状

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

期望

  • 缺少属性类型定义，以及属性类型的跳转 如下图所示，Pointer 的 button 属性应该是一种枚举，deltaPosition 应该是 Vecter2，并且通过点击他们对应的类型应该可以跳转到对应的 API 文档 image
  • API 现在与文档，示例之间的关系比较割裂，如果可以让 API ，文档，示例之间形成一个跳转矩阵，也就是说 API 文档中包含对应示例与对应文档的跳转，那我们就可以大大提升这个 API 对开发者的教育效率
  • API 的链接现在不支持跳转到某个条目

cptbtptpbcptdtptp avatar Sep 06 '23 06:09 cptbtptpbcptdtptp