Skip to content

[Docs] Restructure onboarding docs around Editor/CLI/contributor paths - #1394

Merged
untoldengine merged 3 commits into
developfrom
docs/clarify_docs
Oct 31, 2026
Merged

untoldengine merged 3 commits into
developfrom
docs/clarify_docs

Conversation

@untoldengine

Copy link
Copy Markdown
Owner

Summary

  • Splits "Getting Started" into a game/app-developer path (Editor tour, Editor project walkthrough, CLI walkthrough) and a separate contributor path (clone + demo table), both in docs/Onboarding/
  • Adds GettingStartedWithEditor.md (panels, viewport navigation, selection/gizmo controls, importing and cooking .blend/USD/.ply/.spz assets via Resources → GameData)
  • Renames docs/API/GettingStarted.md → docs/Onboarding/BuildingYourFirstVisionProScene.md, trimmed to the Vision Pro scene narrative (duplicate exporter/asset content now just links to UsingTheExporter.md)
  • Removes docs/LearningPaths/ArchvizToVisionPro.md (redundant with the new onboarding doc); migrates its Blender screenshot
  • Moves the "what is .untold" explainer into UsingTheExporter.md
  • Mirrors the restructured section order (Requirements → Getting Started → Current Features → Watch It in Action → ...) across README.md and docs/index.md
  • Updates mkdocs.yml nav and every cross-reference accordingly

Test plan

  • Verify mkdocs build (or the docs site) renders the new nav and pages without broken links
  • Skim README.md and docs/index.md side by side to confirm they stay in sync

Splits "Getting Started" into separate game/app-developer and
contributor paths, adds a new Editor UI tour and asset import/cook
guide, retires the now-redundant Archviz learning path, and mirrors
the restructure across README.md and docs/index.md.
@untoldengine
untoldengine merged commit ef679f7 into develop Oct 31, 2026
4 checks passed
@untoldengine
untoldengine deleted the docs/clarify_docs branch October 31, 2026 15:07
@untoldengine untoldengine mentioned this pull request Nov 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant