Skip to main content
Use this page as the docs metadata policy for manual + scripting pages.

Why this exists

Mixed docs become hard to trust when code snippets and inspector screenshots drift across SDK revisions. Each page should state what environment it was validated against and where assumptions come from.

Page metadata convention

Add a short section near the top of implementation-heavy pages:
If exact versions are unknown, state “Not pinned — verify against current project manifest.”

Cross-SDK matrix (minimum)

Validation cadence

  • Validate critical runtime pages (session/auth/network/bootstrap) on every SDK release or before major docs publish.
  • Validate UI/editor pages when prefab/component contract changes.
  • Keep screenshot captions aligned with script names and inspector field names.

Authoring checklist

  • Confirm APIs by opening the exact .cs source in the target SDK repo.
  • Mark pages as VR-only or DT-only where relevant.
  • Include one runnable snippet for script-first pages; keep inspector frame for configuration-heavy pages.
  • Add/update Related links when introducing new how-to or troubleshooting pages.