docs: consolidate guides and polish documentation entry points - #778
Merged
Merged
Conversation
Bundle ReportChanges will decrease total bundle size by 20.79MB (-37.99%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: exo-full-iife-Exo-iifeAssets Changed:
Files in
view changes for bundle: exo-iife-Exo-iifeAssets Changed:
view changes for bundle: exo-full-iife-min-Exo-iifeAssets Changed:
Files in
view changes for bundle: exojs-particles-esmAssets Changed:
Files in
view changes for bundle: exo-esm-esmAssets Changed:
view changes for bundle: exo-esm-modules-esmAssets Changed:
view changes for bundle: site-server-esmAssets Changed:
App Routes Affected:
view changes for bundle: exo-iife-min-Exo-iifeAssets Changed:
view changes for bundle: exojs-lighting-esmAssets Changed:
Files in
|
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
Exoridus
marked this pull request as ready for review
September 26, 2026 06:40
Exoridus
enabled auto-merge (squash)
September 26, 2026 06:40
Exoridus
disabled auto-merge
September 26, 2026 06:45
added 5 commits
September 26, 2026 09:04
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.
Summary
Consolidate the documentation around the current runtime, then restore and polish its public entry points. The Guide now has 64 chapters across ten learning-oriented groups; chapter URLs remain independent of those groups, and merged chapters plus former part entry points have explicit redirects. The site, navigation, package READMEs, source-backed examples, and generated API documentation are materialized files, not instructions for a later migration.
The root README restores the branded wordmark, companion, and five
for-the-badgeShields, including live Codecov coverage. CI and coverage explicitly trackmain. Every runtime package has its own table row, including separate Tiled and LDtk entries; project tooling has a matching table, and links work when the README is rendered on npm.Corrections and polish
<ExoCanvas>example, switch scenes through working controls withonErrorand an explicit sizing policy, and start a registered scene in the headlessuseExoApplicationexample.Lighting,ParticleSystem,LoaderScopeandRenderPassInspectorLayerkeeps its examples, ownership, ordering, culling and pixel-snapping contracts, now with the corrections (world-spacecullArea, GPU routing re-evaluated on module changes, debug groups only on custom-material draws).Validation
The dedicated documentation verification completed successfully: https://github.com/Exoridus/ExoJS/actions/runs/36219665685 . Its
documentation-final-evidenceartifact preserves the exact tested revision, command outcomes, full logs, README regression evidence, and generated-page link/fragment report.Passed: Core and package builds, Guide snippet typechecking, educational/example source typechecking, README example typechecking, Astro/site typechecking, site tests including the new README regression, full site build, generated navigation/link/fragment checks, and
git diff --checkagainstnextafter cleanup.Behavior change
LoaderScope.createScope()now throws on a destroyed scope, likeget(),load()andloadContainer()already did. A child created after its parent's teardown was never reached by that teardown, so its claims could not be released through the hierarchy.Scope and integration
Apart from the
createScopeguard, no runtime behavior, package dependency, benchmark measurement, release version, or changelog was changed. The remaining runtime-source edits are JSDoc-only and the corresponding API output was generated from source.Temporary migration scripts, reports, and the review workflow have been removed from the merge candidate. Evidence remains in the Actions artifact and Git history; no permanent root
docs/tree was introduced.