Skip to content

docs: clean demos #189

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 3 commits into from
Mar 4, 2025
Merged

docs: clean demos #189

merged 3 commits into from
Mar 4, 2025

Conversation

damienmontastier
Copy link
Collaborator

@damienmontastier damienmontastier commented Feb 16, 2025

This PR cleans up the usage demos in the documentation (those from version >V2.0) to improve readability. Although the demos have been streamlined, it was still essential to provide users with the complete source code. To achieve this, an expandable menu has been added below each demo, allowing users to view the demo's code.

I've also modified the demos in the documentation introduction. The tags were missing.


Are demos still too massive, or is that okay?

Because the imports can be removed, I just think it's important to keep <TresPerspectiveCamera /> to understand the level at which to activate <EffectComposerPmndrs />.

I haven't modified @Tinoooo demos (before version 2.0), I may do so later when we've agreed on a “basic model” of demo usage style.


The branch is deliberately based on the fix/bad-use-multisampling branch. I also based the PR directly on the bad-use-multisampling branch instead of main. I don't know if that's a good practice or not, you tell me!
Capture d’écran 2025-02-16 à 17 41 44

@damienmontastier damienmontastier added documentation Improvements or additions to documentation docs Improvements or additions to documentation labels Feb 16, 2025
@Tinoooo
Copy link
Contributor

Tinoooo commented Mar 4, 2025

Thank you @damienmontastier for the cleanup! Very cool! Sorry for the late review.

@Tinoooo Tinoooo merged commit 00e0efd into fix/bad-use-multisampling Mar 4, 2025
3 of 4 checks passed
@Tinoooo Tinoooo deleted the docs/clean-demos branch March 4, 2025 18:26
Tinoooo pushed a commit that referenced this pull request Mar 9, 2025
* fix: delete multisampling used in TresCanvas props

* docs: clean demos (#189)

* demos (>v2.0) cleaned and review
* add suspense to introduction demo code
* change language demo code, add highlights lines
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants