📖 Document Improvement Project 🔨

[Aarebecca]

In order to help G6 create more user-friendly and easily accessible documentation, we hereby launch this project.
For those community users who have put forward important suggestions and made outstanding contributions during the improvement process of the G6 documentation, we will send AntV peripheral gifts 🎁.

You can participate in the following ways:

1. Reply under this Issue with all kinds of problems you have found or think exist in the official documentation of G6 5.0.

For example, any situation where you think the G6 5.0 documentation is worthy of improvement, such as unclear expression, missing content, errors, etc.

2. Contribute a PR for G6 for the problems or improvement points in the documentation and associate it with this Issue.

---

为了助力 G6 打造出更易于上手操作以及便捷查阅的文档，我们特此启动此项计划。
对于那些在 G6 文档改进过程中提出重要建议、做出突出贡献的社区用户，我们将送上 AntV 周边礼品🎁。

你能够通过以下方式参与其中：

1. 在该 Issue 下回复你所发现或者认为 G6 5.0 官方文档中存在的各类问题。

例如表述不够清晰、内容有所缺失、出现错误等任何你觉得 G6 5.0 文档有值得改进之处的情况。

2. 针对文档中存在的问题或者改进点，为 G6 贡献 PR，并与该 Issue 相关联。

[Rey-Wang]

求一份自定义节点的详细代码实例

[Aarebecca]

求一份自定义节点的详细代码实例

可以参考：自定义节点

[Rey-Wang]

求一份自定义节点的详细代码实例

可以参考：自定义节点

需要一个类似于生命周期函数的列表，现在写自定义节点很难知道应该覆盖哪个函数

[AmorDiamond]

请问树形布局下，有没有方法能控制默认展开的节点，不需要全部展开。以及控制相邻节点只能同时展开一个。 @Aarebecca

[Aarebecca]

求一份自定义节点的详细代码实例

可以参考：自定义节点

需要一个类似于生命周期函数的列表，现在写自定义节点很难知道应该覆盖哪个函数

参考：https://g6.antv.antgroup.com/api/reference/g6/elementhooks

[Aarebecca]

以及控制相邻节点只能同时展开一个

在数据中配置 collapsed 即可

[liuyonghu]

不会真的感觉文档写的一点问题都没有吧，怀疑都没有人审稿。
去看看这里的 type ，怎么解释的，然后举一反三去查吧。
https://g6.antv.antgroup.com/api/reference/g6/nodeoptions

[veaba]

老实说，文档门槛实在太高，压根不知道找到想使用的示例。

建议不要站在开发者的角度去怎么写，而站在初学者角度，看怎么降低学习门槛会比较重要，不要指望用户都达到开发者的知识水平哈。

举个实例：

1、想要找到 框选的 node 的事件，于是找到 https://g6.antv.antgroup.com/api/behaviors/brush-select#api ，问题来了，key 的枚举是什么？给个 link 去查询一下吧，或者 demo 中提供下，console 代码也行呀，对于新手，想在几分钟内上手，去学习几年开发的东西，想来也是挺难的。

2、挺认可这些酷炫的示例，就是上手文档门槛太高，再花费半小时，再找不到想要的功能的使用方法，不得不考虑使用的图表库啦

3、文档地址在这里：https://github.com/antvis/G6/tree/v5/packages/site ，自己动手

[sabercoding]

从4.x升级到5.0，用的是这个样例，定制不同节点的参数，各种参数都变了，调不出来布局了

[liuyonghu]

从4.x升级到5.0，用的是这个样例，定制不同节点的参数，各种参数都变了，调不出来布局了

不知道是我们表达有问题，还是他们理解有问题，多明显的文档错误，就是答非所问，还天天公众号搞事情，就是为了 KPI 吗？

[hustcc]

@liuyonghu 两件事情哈，不扯到一起，不让让做这个事情的同学感受也不好。

文档缺失不好，去年一年投入也需要考虑 ROI，所以文档上忽略了一些，马上就会准备把文档上搞起来了，其实文档的难点还在于不知道怎么写才容易，因为维护者对库比较熟悉，很容易写着写着就变成「我们能看懂，但是其实就是天书」的样子。

[veaba]

@liuyonghu 两件事情哈，不扯到一起，不让让做这个事情的同学感受也不好。

文档缺失不好，去年一年投入也需要考虑 ROI，所以文档上忽略了一些，马上就会准备把文档上搞起来了，其实文档的难点还在于不知道怎么写才容易，因为维护者对库比较熟悉，很容易写着写着就变成「我们能看懂，但是其实就是天书」的样子。

赞同！

我也是一位新手，在此鼓励开发者继续努力，同时勉励社区一同改善，没必要歪楼。