antvis/G2

G2的文档要好好优化一下 #3247

phker posted onGitHub

  • I have searched the issues of this repository and believe that this is not a duplicate.

What problem does this feature solve?

G2是个非常好的框架, 但是毁在了不够详细和人性化的文档上. 文档写的实在是太粗糙了.而且排版也很粗糙. 跟JAVA API文档有的一比.

优秀的文档应当是图文并茂的, 见其配置同时也知道它的效果.例如下面的这种文档就非常的人性化, https://g2.antv.vision/zh/docs/manual/concepts/component/overview

糟糕的文档就是下面这种 https://g2.antv.vision/zh/docs/api/general/tooltip

很多人的脑海里根本就没有可视化的基础概念, 看到配置项也不知道配置的是个啥. 影响的有哪些.

What does the proposed API look like?

建议https://g2.antv.vision/zh/docs/api 下面的所有文档都应当优化, 排版结构化, 增加缩进. 体现出层次感, 更重要的是增加一些选项对应的动态图. 一图胜千文. 多多利用图片来减少文档的理解难度. 尤其是可视化的框架更应该要在图片上下一些功夫. G2是非常非常优秀的框架, 莫让最后一点文档的工作埋没了它.

<!-- generated by antv-issue-helper. DO NOT REMOVE -->


文档是真的臭,臭的不能再臭了

posted by Niubility-SunLight 11 months ago

Fund this Issue

$0.00
Funded

Pull requests