software-mansion / software-mansion/TypeGPU

docs: Missing documentation

Open
#2,275 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

MACROTASK
Dominant language
TypeScript
Stars
3.2k
Forks
122
Avg merge
3d 5h
Merged PRs (30d)
34

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 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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the manual/reference documentation and package READMEs, then choose one checklist section such as Getting Started, Functions, Pipelines, or Textures. Compare the current content with the requested topics and update that focused area; done means the selected checklist item is documented and the reference API remains after the manual docs in search results.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.