Add Streamed SOG and Voxel format specs, fix splat doc errors, adopt "Streamed SOG" terminology#1044
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the finalized Streamed SOG format, corrects several accuracy issues in the existing SOG specification, and updates docs to consistently use “Streamed SOG” terminology (with mirrored Japanese translations).
Changes:
- Added new Streamed SOG format specification pages (EN/JA) and linked them from the sidebar + formats index.
- Fixed SOG spec inaccuracies (log-domain scales codebook decoding, quaternion ordering/mode mapping,
antialiasoptionality, plus missingassetin JA). - Renamed “LOD streaming” → “Streamed SOG” across relevant guides/tutorials while preserving existing URLs/anchors.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Adds the new Streamed SOG format page to the Gaussian splatting formats sidebar group. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-splat.md | Updates pc-splat tag docs terminology to “Streamed SOG”. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/supersplat/upload.md | Renames SSOG upload option label/description to Streamed SOG terminology. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/supersplat/streaming.md | Updates SuperSplat streaming page wording to Streamed SOG terminology. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/supersplat/index.md | Updates SuperSplat overview copy to Streamed SOG terminology. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/splat-transform/index.md | Updates Streamed SOG generation section naming and references. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/gaussian-splatting/rendering-architecture/splat-data-format.md | Replaces “LOD streaming resources” wording with “Streamed SOG resources”. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/gaussian-splatting/rendering-architecture/index.md | Updates rendering architecture page references from LOD streaming to Streamed SOG. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/gaussian-splatting/formats/streamed-sog.md | Adds Japanese Streamed SOG format specification (new doc page). |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/gaussian-splatting/formats/sog.md | Applies SOG spec fixes (asset metadata, optional antialias, log-domain scales, quaternion order/mode). |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/gaussian-splatting/formats/index.md | Expands formats index to include Streamed SOG + comparison table/workflow updates. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/gaussian-splatting/building/performance.md | Updates performance guide sections/phrasing to Streamed SOG terminology. |
| i18n/ja/docusaurus-plugin-content-docs/current/user-manual/gaussian-splatting/building/lod-streaming.md | Retitles/rewrites the “LOD streaming” guide content to “Streamed SOG” while keeping the slug. |
| i18n/ja/docusaurus-plugin-content-docs/current/tutorials/gaussian-splat-streaming-lod.md | Updates tutorial title/description/intro to Streamed SOG terminology. |
| docs/user-manual/web-components/tags/pc-splat.md | Updates pc-splat tag docs terminology to “Streamed SOG”. |
| docs/user-manual/supersplat/upload.md | Renames SSOG upload option label/description to Streamed SOG terminology. |
| docs/user-manual/supersplat/streaming.md | Updates SuperSplat streaming page wording to Streamed SOG terminology. |
| docs/user-manual/supersplat/index.md | Updates SuperSplat overview copy to Streamed SOG terminology. |
| docs/user-manual/splat-transform/index.md | Updates Streamed SOG generation section naming and references. |
| docs/user-manual/gaussian-splatting/rendering-architecture/splat-data-format.md | Replaces “LOD streaming resources” wording with “Streamed SOG resources”. |
| docs/user-manual/gaussian-splatting/rendering-architecture/index.md | Updates rendering architecture page references from LOD streaming to Streamed SOG. |
| docs/user-manual/gaussian-splatting/formats/streamed-sog.md | Adds English Streamed SOG format specification (new doc page). |
| docs/user-manual/gaussian-splatting/formats/sog.md | Applies SOG spec fixes (optional antialias, log-domain scales, quaternion order/mode). |
| docs/user-manual/gaussian-splatting/formats/index.md | Expands formats index to include Streamed SOG + comparison table/workflow updates. |
| docs/user-manual/gaussian-splatting/building/performance.md | Updates performance guide sections/phrasing to Streamed SOG terminology. |
| docs/user-manual/gaussian-splatting/building/lod-streaming.md | Retitles/rewrites the “LOD streaming” guide content to “Streamed SOG” while keeping the slug. |
| docs/tutorials/gaussian-splat-streaming-lod.md | Updates tutorial title/description/intro to Streamed SOG terminology. |
💡 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.
Overview
Makes the developer site the canonical home for the splat-transform format specs and
guides, documents the newly finalized Streamed SOG format, fixes accuracy errors in
the SOG spec and the Streamed SOG guide, and renames "LOD streaming" to "Streamed SOG"
across the docs. All changes are mirrored in the Japanese translations.
Companion splat-transform PR deletes the duplicated
guides/folder from that repo andrepoints its README here — this PR must deploy first so those links resolve.
New: Streamed SOG format specification
user-manual/gaussian-splatting/formats/streamed-sog(en + ja), followingthe SOG spec's structure (file set → meta interface → tree semantics → example →
versioning).
lod-meta.jsonv1:version,asset.generator,count/counts, optionalenvironment,filenames, and the spatialtree, plus previously undocumentedsemantics (leaf bounds include Gaussian extents, LOD 0 = highest detail,
offset/countsplat ranges with per-run Morton order, pre-versioning compatibility).comparison table and workflow updates).
Matches the
lod-meta.jsonoutput finalized in the companion splat-transform change.New: Voxel format specification
user-manual/splat-transform/voxel-format(en + ja), ported from thesplat-transform repo's
VOXEL_FORMAT.md— previously the only format spec without adeveloper-site home.
the spec had nowhere to point on this site) and gains a "See also" entry.
Fixed: SOG spec accuracy (verified against splat-transform and engine source)
exp(); previously documented aslinear-space, which would produce garbage sizes if implemented as written.
(w, x, y, z)ordered;now stated explicitly, and the mode case comments were off by one position
(mode 0 = w omitted … mode 3 = z, not x…w).
antialiasis now optional — no writer emits it, so as written every shipped SOGfile was non-conformant.
assetfield (it predated that addition).Fixed: Streamed SOG guide accuracy (verified against engine source)
leaked from the engine's
GSplatOctreeclass name). Theresource?.octree?.lodLevelscode snippet is unchanged since that's the literal API property name.
lodMultiplierdefault corrected to 3, clamped to ≥ 1.2 (was documented as 2).lodDistancesAPI).{#global-splat-budget}anchor.Renamed: "LOD streaming" → "Streamed SOG"
Across 11 en + 10 ja pages (building guide, performance, rendering architecture,
splat-transform, SuperSplat pages, pc-splat reference, tutorial). Deliberately unchanged:
/building/lod-streaming, tutorial slug) — avoids breaking inbound links;titles and sidebar labels now read "Streamed SOG".
<EngineExample>ids and the{#generating-lod-format}explicit anchor.Verification
docusaurus buildsucceeds for en and ja with no broken links; the only remainingbroken-anchor warning (
managing-scripts) predates this PR and is unrelated.