software-mansion / software-mansion/TypeGPU
docs: Add a page with all the niceties typegpu provides
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 3.2k
- Forks
- 122
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 34
Description
- No need to worry about byte alignment,
- no need to worry about group and binding indices,
- buffer.asMutable(),
- await buffer.read(),
- (once we have them after #1186 and such) extra std functions,
and similar.
I think it would be beneficial in convincing potential users to have those listed all in one place, as bullet points with a short explanation or a link to other segment of the docs. I'd see it either on the Why TypeGPU? page, or on a new subpage.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing “Why TypeGPU?” page and documentation sections covering buffer helpers, alignment, bindings, and standard functions. Add a single page or subpage that lists these niceties with short explanations or links, and consider the work done when the listed benefits are gathered in one discoverable place.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100