docs: Common code between examples #1995
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
pkg.pr.new packages benchmark commit |
There was a problem hiding this comment.
Pull request overview
This PR introduces a common folder for shared code between documentation examples to reduce duplication. The primary change involves moving the setup-orbit-camera.ts utility from individual example directories to a centralized common location.
- Establishes infrastructure to handle common files across examples with proper type definitions
- Refactors
setup-orbit-camera.tsto be a shared utility with enhanced touch gesture support (pinch-to-zoom) - Updates build tooling to automatically include relevant common files in StackBlitz exports and code editor views
Reviewed changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| apps/typegpu-docs/src/utils/examples/types.ts | Adds ExampleCommonFile type to distinguish common files from example-specific files |
| apps/typegpu-docs/src/examples/simulation/gravity/setup-orbit-camera.ts | Removes local copy of orbit camera utility (moved to common folder) |
| apps/typegpu-docs/src/examples/simulation/gravity/schemas.ts | Updates import path to reference common folder |
| apps/typegpu-docs/src/examples/simulation/gravity/index.ts | Updates import path to reference common folder |
| apps/typegpu-docs/src/examples/rendering/phong-reflection/index.ts | Updates import path and removes export keywords from shader functions |
| apps/typegpu-docs/src/examples/exampleContent.ts | Adds common file loading logic with glob patterns and path extraction |
| apps/typegpu-docs/src/examples/common/setup-orbit-camera.ts | New centralized orbit camera utility with enhanced pinch-to-zoom support |
| apps/typegpu-docs/src/components/stackblitz/openInStackBlitz.ts | Updates to include common files in StackBlitz projects with proper path rewriting |
| apps/typegpu-docs/src/components/ExampleView.tsx | Adds filtering logic to include only relevant common files per example |
| apps/typegpu-docs/src/components/ExamplePage.tsx | Passes common files to ExampleView component |
| apps/typegpu-docs/src/components/CodeEditor.tsx | Updates path handling to support both example and common file paths |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
aleksanderkatan
requested review from
cieplypolar,
iwoplaza,
lursz and
reczkok
iwoplaza
reviewed
Jan 8, 2026
📊 Bundle Size Comparison
👀 Notable resultsStatic test results:No major changes. Dynamic test results:No major changes. 📋 All resultsClick to reveal the results table (323 entries).
If you wish to run a comparison for other, slower bundlers, run the 'Tree-shake test' from the GitHub Actions menu. |
iwoplaza
approved these changes
Jan 14, 2026
added 9 commits
January 15, 2026 10:21
aleksanderkatan
force-pushed
the
docs/common-code-between-examples
branch
from
b9acc45 to
e8712fb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
commonfolder to examples,commonfiles when opening in StackBlitz,commonfiles in our examples,setup-orbit-camera.tsto be common (only where it was already used).