Skip to content

Latest commit

 

History

History
54 lines (51 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

54 lines (51 loc) · 1.36 KB

Content Structure

The Hubs documentation site has several different types of content that covers both Hubs and Spoke. Please keep the following structure in mind when creating new documentation files for the site.

  • Getting Started Guides

    • Guide #1 - Getting Started With Hubs
    • Guide #2 - Building a Scene with Spoke
  • Hubs Reference

    • Scenes
      • Scene Browser
      • Lobbies and Rooms
      • Sharing Invites
      • Receiving Invites
      • User List
      • Chat
      • Notifications
      • Name
      • Entering a Room
      • Entering on a Mobile VR Headset
    • In Room Experience
      • Moving Around
        • Fly Mode
      • Growing and Shrinking
      • Muting
      • Adding video, audio, 3D models and images
      • Moving Objects
      • Menus
      • Pinning
      • Blocking
      • Using Chat
      • Using the Camera
      • Mirror Mode
      • Focus and Track Mode
      • Using the Pen
      • Sharing Your Screen or Phone/Web Cam
      • Controls
      • User List
      • Object list
      • Moderating rooms
      • Customizing Avatars
      • Discord Integration
  • Spoke Reference

    • Lighting and shadows
    • Physics and Navigation
    • Creating Assets for Spoke
    • Using Spoke Scenes in your own Projects
    • Keyboard and Mouse Controls
    • (Example) Asset panel
    • (Example) Element Properties
  • For Developers

    • Hubs system overview
    • (Example) source code
    • (Example contributing to Hubs and spoke