docs: restructure shadows page into a tuning pipeline#1037
Merged
Conversation
Reorder the page into a clean reading pipeline: enable, choose technique, tune quality, fix artifacts, mind performance. - Rename "Shadow Type" to "Shadow Types" (anchor unchanged) - Reorder Tuning Shadows to Resolution, Distance, Cascades, Intensity so the finite-resolution narrative flows naturally - Demote Shadow Cascades from its own top-level section into Tuning Shadows, folding its two sub-headings into prose - Group Shadow Bias and Normal Offset Bias under a new "Fixing Shadow Artifacts" section so troubleshooting is discoverable from the TOC - All existing anchor IDs are preserved; no inbound links break - Mirror the restructure in the Japanese translation Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Mention in Enabling Shadows that gsplat components can cast (but not receive) shadows, with casting disabled by default; add gsplat examples to the Engine, Editor, React and Web Components tabs - Rename the #shadow-type anchor to #shadow-types to match the heading, updating the internal cross-reference and the inbound links from the clustered lighting page - Mirror all changes in the Japanese translation Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the “Shadows” user manual page to present shadow setup and troubleshooting as a clear tuning pipeline (enable → choose type → tune quality → fix artifacts → performance), and mirrors the same structural changes in the Japanese translation.
Changes:
- Renames Shadow Type → Shadow Types while preserving the existing
#shadow-typeanchor. - Reorders and reorganizes the Tuning Shadows subsections (Resolution → Distance → Cascades → Intensity), demoting Shadow Cascades to a subsection and folding its former subheadings into prose.
- Introduces a new Fixing Shadow Artifacts section that groups Shadow Bias and Normal Offset Bias for better TOC discoverability.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/user-manual/graphics/lighting/shadows.md | Restructures the English Shadows page into the new pipeline flow; preserves existing anchors and reorganizes cascades/bias content. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/graphics/lighting/shadows.md | Mirrors the same restructuring in the Japanese translation, including the new troubleshooting section and updated tuning order. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
What changed
Restructures the Shadows page (
docs/user-manual/graphics/lighting/shadows.md) so it reads as a pipeline — enable → choose technique → tune quality → fix artifacts → mind performance — with the Japanese translation mirrored identically.New structure:
A second commit adds two content changes on top of the restructure:
#shadow-type→#shadow-typesto match the renamed heading, with the internal cross-reference and the inbound links from the Clustered Lighting page (EN + JA) updated in the same commit.Why
The previous structure had "Tuning Shadows" as a grab-bag in arbitrary order, Shadow Cascades stranded after it despite being a directional-quality control, and the bias properties (problem-solving content) buried among quality knobs. Gsplat shadow casting was undocumented on this page.
Notes for reviewers
#shadow-type(renamed with all references updated) and the unreferenced#number-of-cascades/#distribution-of-cascades(folded into prose). External bookmarks to the old#shadow-typefragment will land at the top of the page, which is harmless.GSplatComponenthascastShadows(defaultfalse) and noreceiveShadows.🤖 Generated with Claude Code