Skip to content

Documentation design principles

The portal follows the same broad information architecture that makes mature 3D web libraries approachable:

  • A direct quick start
  • A browser-based editor
  • Topic-focused live examples
  • A separate exact API reference
  • Browser support, troubleshooting, and FAQ pages
  • Clear distinction between beginner workflows and advanced implementation details

The main structural reference was the public <model-viewer> documentation, including its separation of the editor, examples, API reference, and browser support. The augmented-reality example page also demonstrates a useful pattern: explain one capability at a time beside a running example rather than presenting a disconnected code catalog.

Model Lab's documentation is independently written for its React Three Fiber architecture. It does not copy Model Viewer source code, examples, wording, or visual assets.

The portal uses VitePress because it provides Markdown-based file routing, documentation navigation, local search, and static output. The exact public TypeScript surface can additionally be generated with TypeDoc.

Released under the MIT License.