Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] 4.x文档建议优化 #2480

Closed
liuxuan1-1 opened this issue May 20, 2020 · 7 comments
Closed

[DOC] 4.x文档建议优化 #2480

liuxuan1-1 opened this issue May 20, 2020 · 7 comments

Comments

@liuxuan1-1
Copy link

liuxuan1-1 commented May 20, 2020

对于一个之前没有接触过G2的新人来说, 第一次尝试4.x的G2实在太痛苦的, api文档感觉和没写差不多.

首先我这个项目是个JS项目, 不太好升级到TS. 虽然vscode也支持识别JS项目直接识别.d.ts文件, 不过跨个函数就凉凉了.

我来举个最简单的例子🌰好了:
需求要一个视图叠加两种不同类型的图形, 因此想要同步坐标轴, 我根本不记得在G2 4.x文档哪里看到有个sync属性可以配置同步, 于是我分别在如下链接中寻找详细说明:

  1. 基础教程-度量配置
  2. 核心概念-数据类型与度量
  3. API文档 这里手动 command+f 没搜到

最后终于经过翻代码和到处搜索分别在

  1. interface.d.ts => ScaleOption 中发现了定义:
    image

  2. 3.x文档
    image
    3.x api 文档这里还有个demo链接, 不错

希望大佬们可以把文档整理整理, 或者搞的稍微详细一点, 谢谢!

@liuxuan1-1
Copy link
Author

image
还有这里类型竟然是一个string[] ... , apply是干嘛的?

@liuxuan1-1 liuxuan1-1 changed the title [doc] 4.x文档建议优化 [DOC] 4.x文档建议优化 May 20, 2020
@liuxuan1-1
Copy link
Author

liuxuan1-1 commented May 21, 2020

放弃了..., 改用Echarts了, 搞了两天的东西, Echarts从头开始学, 半天就搞定了.....

@WangGuanJie1
Copy link

我真的认为建立个向Echarts那样的社区很有必要,通过社区建设可以极快学习使用

@liuxuan1-1
Copy link
Author

文档也很关键

@Orange8
Copy link

Orange8 commented Jun 9, 2020

4.x的文档确实看不懂,没有3.x的清晰

@zhangyu1818
Copy link

我是新手,文档看懵了,ts定义里写的还要比文档清楚一点

@hustcc
Copy link
Member

hustcc commented Sep 18, 2020

非常不好意思,我们正在专人整理文档,统一到这里了 issue ,#2713

@hustcc hustcc closed this as completed Sep 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants