plotly / plotly/plotly.js

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

Abierto
#7,772 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

documentation feature P3 size: 1
Lenguaje dominante
JavaScript
Estrellas
18.3k
Forks
2k
Merge medio
2 d 12 h
PR fusionados (30 d)
28

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con CONTRIBUTING.md y la posible ubicación docs/webgl_debugging.md; después, usa el issue #7387 y el flujo de renderizado de scattergl como contexto. Documenta la estructura de las trazas de WebGL, los puntos de entrada del renderizado, regl.clear() y los patrones de gestión de buffers, además de consejos de depuración para las advertencias de renderizado; se considerará terminado cuando los colaboradores puedan seguir el flujo de trabajo sin explorar extensamente la base de código.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript
Área
computer-graphics, documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.