Skip to content

Tracker luma.gl docs and website improvements #2407

@ibgreen

Description

@ibgreen

We have a couple of major projects that are considering adopting luma.gl as a path to WebGPU, however the quality of the docs has come up as a concern.

This tracker task is open for users to add bullets about areas that could be improved

Docs - Sanity pass

  • api guide shaderlayout - probably needs a pass to align with latest API
  • api guide bindings - likely needs a pass
  • engine Model docs have never been good - arguably the most important page in the docs
  • gltf @luma.gl/gltf module, add basic docs - @ibgreen
  • tutorials - port to v9 (currently marked as outdated) @ibgreen Tracker luma.gl docs and website improvements #2407

Website / Examples

  • Website: (<DeviceTabs /> issue - Switching to WebGPU tab in one example should not persist when switching to non-WebGPU enabled example
  • Examples: glfx - Port to WebGPU - P1 - TBD
  • Examples: glfx - Restore example (so that we can test / showcase postprocessing modules) - P1 - TBD
  • Examples: showcase/persistence - P0 - Use effects instead of custom shaders
  • Examples: showcase/persistence - P0 - Port to WebGPU
  • Examples: api/cubemap - P0 - Fix projection angles in WebGPU @ibgreen
  • Examples: showcase/instancing - P0 - Implement cube picking on WebGPU @ibgreen
  • Examples: showcase/instancing - P1 - Use dirlight module @ibgreen
  • Examples: showcase/instancing - P0 - Port to WebGPU @ibgreen

Docs - Improvement areas

  • gltf @luma.gl/gltf module, write good docs
  • tutorials - refresh to make more useful (currently heavy focus on special features like shaderhooks and transforms)
  • engine BufferTransform / TextureTransform docs - @donmccurdy

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions