-
Notifications
You must be signed in to change notification settings - Fork 221
Open
Description
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
- tutorials - refresh to make more useful (currently heavy focus on special features like shaderhooks and transforms)
- tutorials - port to v9 (currently marked as outdated) @ibgreen Tracker luma.gl docs and website improvements #2407
- api guide shaderlayout - probably needs a pass to align with latest API
- api guide bindings - likely needs a pass
- api-reference/engine/Model docs have never been good - arguably the most important page in the docs
- engine
BufferTransform/TextureTransformdocs - @donmccurdy - gltf
@luma.gl/gltfmodule, write good docs - api-reference/gltf
@luma.gl/gltfmodule, add basic docs - @ibgreen - api -reference /core/Device - link device creation methods to resource prop type docs @ibgreen docs: link device resource creators to props #2460
- api reference/core/Texture - update TextureProp docs - docs: update texture props documentation #2459
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
Reactions are currently unavailable