antvis / antvis/G2

关于文档查找API使用说明找不到的问题

Open
#6,387 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
12.6k
Forks
1.7k
PR merge metrics
No merged PRs in 30d

Description

这个文档真实一言难尽。。。。。。
想使用treemap,愣是没找到对应的说明,比如说示例里面的

![image](https://github.com/user-attachments/assets/9bd973bb-eb7c-45f4-b7cc-cce2ad53752b)

我想找找关于treemap的layout的参数说明,尤其是里面的path配置,从文档的核心概念开始找

![image](https://github.com/user-attachments/assets/059b01c7-1681-41fb-8792-10bb73c716a7)

这应该是指引我去文档里面找吧

![image](https://github.com/user-attachments/assets/92d98cd2-42d1-4b32-8189-a6f50e39fb8f)
![image](https://github.com/user-attachments/assets/bd5858cc-84e8-451b-85f2-f3581e11d831)

按理说到这里我应该去看看 TreemapLayout 这个类型吧,但是。。。没了。。。压根就没有这个类型相关的内容,搜索框搜索出来的还是这一页。

不能说文档要包含多复杂的使用场景,最基本的参数说明要有吧,图表示例里面还有一个矩形树下钻的示例,interaction里面配置了treemapDrillDown参数,文档里同样找不到,搜不到

![image](https://github.com/user-attachments/assets/9fe4b625-8514-4288-8372-bb5314a248e2)

Contributor guide

Open the contributing guide

Research direction

Start by tracing the Treemap examples and the API or type references for TreemapLayout, its path configuration, and treemapDrillDown. Document the missing parameter guidance and ensure these concepts are searchable and reachable from the relevant examples and core-concept pages.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.