software-mansion / software-mansion/TypeGPU
docs: Better example trivia & attributions
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.2k
- Forks
- 122
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 34
Description
Right now, we create dedicated popups every time we want to explain controls and for every attribution.
We could make a generalized system for all examples that displays some info, and include the info in metadata.
It could look like this:
We could either include all info in one such tooltip, or have different tooltips for attribution, controls, example description...
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 locating the existing dedicated popups used for control explanations and attributions in the examples. Compare how their information is represented, then determine the metadata and tooltip structure needed for a generalized system covering attribution, controls, and example descriptions. Done means the examples can display this information without separate popup implementations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100