plotly / plotly/plotly.js

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

Đang mở
#7,772 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

documentation feature P3 size: 1
Ngôn ngữ chính
JavaScript
Star
18.3k
Fork
2k
Merge trung bình
2 ngày 12 giờ
Pull request đã merge (30 ngày)
28

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với CONTRIBUTING.md và vị trí có thể có của docs/webgl_debugging.md, sau đó sử dụng issue #7387 và luồng rendering của scattergl làm ngữ cảnh. Hãy ghi lại cấu trúc của WebGL trace, các điểm bắt đầu rendering, regl.clear() và các pattern quản lý buffer, cùng với các mẹo debugging cho cảnh báo rendering; hoàn thành có nghĩa là contributor có thể làm theo workflow mà không cần khám phá codebase quá nhiều.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript
Lĩnh vực
computer-graphics, documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
48/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.