plotly / plotly/plotly.js

[FEATURE]: Improve contributor documentation for WebGL rendering and debugging workflow

未关闭
#7,772 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

documentation feature P3 size: 1
主要语言
JavaScript
星标
18.3k
派生
2k
平均合并
2 天 12 小时
30 天内合并 PR
28

描述

Problem

While contributing a fix for issue #7387, I found that understanding the WebGL rendering flow (especially for scattergl) required significant exploration of the codebase.

There is currently limited contributor-oriented documentation explaining:

  • how WebGL traces are structured
  • where rendering logic is implemented
  • how functions like regl.clear() are expected to behave
  • how to debug rendering-related warnings

Proposed Solution

Add a short developer-focused documentation section covering:

  • Overview of WebGL-based traces (e.g., scattergl)
  • Key rendering pipeline entry points
  • Usage patterns for regl.clear() and buffer management
  • Common debugging scenarios and tips

Possible Implementation

This could be added as:

  • a section in CONTRIBUTING.md
  • a new markdown file (e.g., docs/webgl_debugging.md)
  • or a developer note linked from the main documentation

Benefits
  • Helps new contributors onboard faster
  • Reduces debugging time
  • Improves code maintainability
  • Encourages more contributions in rendering-related areas

Context

This suggestion is based on my experience contributing to:
https://github.com/plotly/plotly.js/issues/7387

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 CONTRIBUTING.md 和可能的 docs/webgl_debugging.md 位置开始,然后以 issue #7387 和 scattergl 渲染流程作为上下文。记录 WebGL trace 结构、渲染入口、regl.clear() 和缓冲区管理模式,以及渲染警告的调试技巧;完成的标准是贡献者无需大量探索代码库即可遵循该工作流。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
computer-graphics, documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
冷清
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。