antvis / antvis/G6

📖 Document Improvement Project 🔨

Open
#6,463 16 comments 2 reactions 0 assignees View on GitHub
Gift 🎁
Dominant language
TypeScript
Stars
12.3k
Forks
1.6k
PR merge metrics
No merged PRs in 30d

Description

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 相关联。

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names only the official G6 5.0 documentation, not a file, page, or failing test. Start by reviewing that documentation and the existing comments for a specific unclear, missing, or incorrect section; done means a focused documentation PR linked to this issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
data-visualization, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.