antvis/G6

Do you want to work on this issue?

You can request for a bounty in order to promote it!

[Docs]: 编写文档板块「3D 扩展包(总览、3D 节点、相机设置插件等)」 #6992

yvonneyx posted onGitHub

任务介绍

此 ISSUE 为 AntV 开源共建计划(AntV Open Source Contribution Plan,简称 AntV OSCP)Phase3 - 文档季的任务 ISSUE,欢迎社区开发者参与共建~

This ISSUE is one of the tasks of the AntV Open Source Contribution Plan (referred to as AntV OSCP) Pharse3 - Season of Docs . Welcome to join us in building it together!

新增文档板块「3D 扩展包(总览、3D 节点、相机设置插件)」

任务介绍

  • 任务名称:新增文档板块「3D 扩展包(总览、3D 节点、相机设置插件)」
  • 技术方向:g6 / docs
  • 任务难度:专家 🌟🌟🌟
  • 可获得积分:100分

详细要求

为更好地支持 G6 用户在三维可视化方向上的探索与实践,计划在官方文档中新增一个独立的模块,用于系统性地介绍 G6 的 3D 扩展包。该模块将覆盖所有与 G6 3D 功能相关的内容,包括但不限于:

📦 模块内容规划:

  • 3D 扩展包总览:介绍 3D 扩展包的整体能力、适用场景、依赖环境等。
  • 安装与使用指南:如何引入 3D 扩展包,基础的初始化与配置方式。
  • 3D 节点配置:讲解如何使用 G6 渲染立体节点,支持的几何形状、贴图、动画等配置项。
  • 相机设置插件:如何使用相机插件进行视角控制、缩放限制、初始视角设置等。
  • 3D 布局支持:可选,介绍目前支持的 3D 布局类型及使用示例。
  • 常见问题与性能优化建议:使用 3D 相关功能时的注意事项、常见错误和优化技巧。

能力要求

- 对 G6 有深入的了解,能阅读 G6 源码,编写示例。

执行路径

1. 认领任务

选择感兴趣的且没有 Assignee 的任务,按格式回复,该任务 assign 给你后即为成功认领~

  • 认领回复格式:【@GitHub ID + Give it to me】
  • eg:【@yvonnyx Give it to me】

2. 做任务

  1. clone g6 代码
git clone https://github.com/antvis/G6.git
  1. 拉取所有线上分支
git fetch
  1. 切换到 v5 分支
git checkout v5
  1. 安装依赖
pnpm install
  1. 进入 site 包
cd packages/site
  1. 本地启动 site 站点
pnpm run dev
  1. 优化文档并预览效果

3. 提交 PR

请保证文档语意通顺、格式正确、代码示例完整且能够正确编译,否则该 PR 将不会被 review 和 merge,此 issue 将被重新释放。

  1. 提交 Pull Request,等待 Code Review
  • PR 标题参考 docs: 任务名称 ,如 docs: 改造点击选中交互文档 ,并关联 OSCP 标签,以便快速进入 PR review 阶段。
  • PR 与对应任务 ISSUE 进行关联,方式:在 PR 正文中,通过 - Fixed: #任务 ISSUE 号 即可实现关联,eg:

Image

  1. 根据(多次) Code Review 建议修改

3 等待合并入 v5 分支后,积分生效


Fund this Issue

$0.00
Funded
Only logged in users can fund an issue

Pull requests