Skip to content

docs: Rework example selection UI and add searching utilities. #1230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 26 commits into from
May 28, 2025

Conversation

reczkok
Copy link
Contributor

@reczkok reczkok commented May 12, 2025

closes #1243

  • Integrate with lfs
  • Figure out better tags (suggestions very welcome)
  • Maybe some better thumbnails?
  • Bring back multiple image sizes (got lost somewhere in stash...)
Device Before After
Desktop Before desktop After desktop
Mobile Before mobile 1
Before mobile 2
After mobile 1
After mobile 2

The "welcome" section now hides when scrolling :D

Screen.Recording.2025-05-12.at.12.30.13.mov

Copy link

github-actions bot commented May 12, 2025

pkg.pr.new

packages

pnpm i https://pkg.pr.new/software-mansion/TypeGPU/typegpu@1230
pnpm i https://pkg.pr.new/software-mansion/TypeGPU/typegpu@e04db86e20c328e95709b38a32df7c614b8adfb8

benchmark
view benchmark

commit
view commit

@reczkok reczkok marked this pull request as ready for review May 14, 2025 12:30
Copy link
Contributor

@aleksanderkatan aleksanderkatan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great change!
Some examples are missing thumbnails though -- the three new ones: Gravity, Oklab and Stable Fluids, and one old one: TGSL parsing test.

@mhawryluk
Copy link
Contributor

-> release branch

@reczkok reczkok force-pushed the docs/example-tags branch from 94ca948 to 463a839 Compare May 15, 2025 14:11
@reczkok reczkok changed the base branch from main to release May 15, 2025 14:12
@aleksanderkatan
Copy link
Contributor

I think we should create atomics and double buffering tags and rename the two fluid examples to have slightly different names

@aleksanderkatan
Copy link
Contributor

I think it might be cleaner to get rid of the example categories on the user side and to turn them into tags (we can keep the internals for sorting purposes), what do you think?

@iwoplaza
Copy link
Collaborator

I think we should create atomics and double buffering tags and rename the two fluid examples to have slightly different names

Hmm, maybe "Cellular Liquid (coarse)" instead of "Fluid (with atomics)" and "Cellular Liquid (granular)" instead of "Fluid (double-buffering)"?
The naming is mostly motivated by what each example is trying to model. The former is more suited for simulating fluid on a macro-scale (coarse cells), and the latter is more suited for simulating fluid on a micro-scale (more granular cells)

@iwoplaza
Copy link
Collaborator

(also I wish I could see the changes myself, but there's a missing image, probably due to Git LFS)

@reczkok
Copy link
Contributor Author

reczkok commented May 22, 2025

I think it might be cleaner to get rid of the example categories on the user side and to turn them into tags (we can keep the internals for sorting purposes), what do you think?

I think for someone not looking for anything in particular the categories can be nice - we still search by them under the hood. I would also like to avoid crowding the tags.

@reczkok
Copy link
Contributor Author

reczkok commented May 22, 2025

(also I wish I could see the changes myself, but there's a missing image, probably due to Git LFS)

Should be solved @iwoplaza 🫡

@mhawryluk
Copy link
Contributor

Zrzut ekranu 2025-05-26 o 14 11 47

not enough padding at the bottom

Copy link
Contributor

@mhawryluk mhawryluk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! 🎨

Copy link
Collaborator

@iwoplaza iwoplaza left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hurrayy! It looks so good 😭 (also fix the padding at the bottom)

@reczkok reczkok force-pushed the docs/example-tags branch from 126a25d to c734609 Compare May 28, 2025 13:28
@reczkok reczkok force-pushed the docs/example-tags branch from c734609 to cc221d8 Compare May 28, 2025 13:43
@reczkok reczkok merged commit a5d958d into release May 28, 2025
6 checks passed
@reczkok reczkok deleted the docs/example-tags branch May 28, 2025 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Rework the example list
4 participants