Skip to content

docs: Missing documentation #2275

@aleksanderkatan

Description

@aleksanderkatan

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 tsover is 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 std mirrors 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 rawCodeSnippet down (and remove the duplicate).
  • (Utilities) Move branch pruning to functions, and mention comptime there.
  • (React Native) Something about worklets.
  • (WESL Interopability) Update.
  • (Working with wgpu-matrix) Remove.
  • (Resolve) Namespaces.
  • (?) lazy.
  • (?) simulate.
  • (?) Matrix utilities.
  • (?) Type guards (isBuffer etc.),
  • @typegpu/color,
  • @typegpu/sort.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions