G2的文档要好好优化一下

[phker]

• 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是非常非常优秀的框架, 莫让最后一点文档的工作埋没了它.

[hustcc]

@phker 感谢反馈，最开始的文档只有教程，教程是我们常规的图文并茂的形式，后来被区分成教程+API，而 API 最开始是代码类型定义的导出，后来发现很多 api 根本没有必要透出，所以变成了现在的手写，其实和教程还是有部分重叠的。

[visiky]

" 排版结构化, 增加缩进. 体现出层次感" 非常同意

[alphabetabc]

Chart 的实例 是chart
chart,interval(options) 返回的已经是geometry的实例了，这块很有必要的区分一下
geometry的以下方法在chart上根本没有，我被坑了好久 T_T
position、color、shape、size、adjust、style、abel ，要不然调用的时候糊里糊涂的，虽然可以链式调用，其实到最后你已经不是你，却还以为他还是他

[mumu-baba]

为什么有的文档以前存在的现在没有了。导致优化也不知道从何下手，因为没有文档。不知道具体含义。

[mumu-baba]

@hustcc

[mumu-baba]

我记得有一版是有这种写法的api 文档。现在怎么找不到了。能不能给个链接

[hustcc]

你使用的 G2Plot，在 G2 找文档，当然找不到。

[mumu-baba]

@hustcc 我可以确认我用的是g2

[hustcc]

建议暂时不用 G2 的配置化的方式吧，会有不少 bug，直接使用 API 的方式创建图表，或者直接使用 G2Plot。