-
-
Notifications
You must be signed in to change notification settings - Fork 61
docs: Missing documentation #2275
Copy link
Copy link
Open
Description
Make it so the reference api is always after manual docs when searching.
READMEs for packages can also be updated.
- (Getting Started) Unplugin & tsover as core steps, not as tips.
- (Roots) Move enabling features closer to this section, or even merge the sections together.
- (Functions) Mention that
tsoveris completely optional. - (Functions) Be more clear about what is and is not allowed in TypeGPU functions in supported JS functionality.
- (Functions) A section about what becomes const, var and let.
- (?)
d.ref, and also notes about when we copy/reference variables and parameters. - (Functions) Mention that
stdmirrors WGSL stl, and mention new functions. - (Functions) Mention that functions implemented in JS don't need
$uses. - (Functions) Clarify builtins in shellless entry.
- (Functions) Give more JS examples.
- Maybe split Functions into Functions and Entry Functions, or just move entry functions to Pipelines.
- Use the "minimal entry that references more complex function" pattern in docs.
- (Pipelines) Reference Vertex Layouts since we use them.
- (Vertex Layouts) Full docs refresh.
- (Pipelines) Tip: read errors from the end.
- (Pipelines) Use defaults, and mention them.
- (Pipelines) Mention that we can pass context instead of a view.
- (Pipelines) Draw indirect.
- (Pipelines) Render bundles.
- (?) Explain
d.Infer,d.InferGPU, and that we can call schemas to infer the type automatically. - (?) Explain how to type a bind group based on bind group layout.
- Move Data Schemas before Buffers.
- (?)
offsetOf, and copying in a new section. - (Buffers) The synergy with Accessors.
- (Getting Started) Note that you can filter examples by used APIs.
- (Textures) The first snippet needs
'render'usage. - (?) Once SWM has the agent skills repo, link it somewhere.
- (Variables) Foolproof the caution.
- (Utilities) Move
rawCodeSnippetdown (and remove the duplicate). - (Utilities) Move branch pruning to functions, and mention
comptimethere. - (React Native) Something about worklets.
- (WESL Interopability) Update.
- (Working with wgpu-matrix) Remove.
- (Resolve) Namespaces.
- (?)
lazy. - (?)
simulate. - (?) Matrix utilities.
- (?) Type guards (
isBufferetc.), - @typegpu/color,
- @typegpu/sort.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels