Provide better documentation.

At the moment the only documentation is a basic Getting Started guide GETTING_STARTED.md and API documentation DOCUMENTATION.md which is one file that contains all the API docs for each class and prefab.

Proposal:

The documentation should be split up into separate files and go into a Documentation folder structure like:

---

• Documentation/
• Getting Started/
  • SDK Setup * SteamVR.md * OculusUtilities.md * OculusAvatar.md * …etc
  • Learning the Basics/ * Setting up a pointer.md * Setting up grabbable objects.md * Setting up usable objects.md * Interacting with pointer.md * Locomotion with teleporting.md (covers basic/height adjust/dash) * …etc
• Tutorials/ * How to do something that I can’t think of an example for right now.md * …etc
• API/
  • Interactions/
    • VRTK_InteractGrab.md
    • …etc
  • Locomotion/
    • …etc
  • Presence/
    • …etc

---

This document structure would also be mirrored on the readme.io site.

All documents would also follow common docs guidelines, these guidelines could be stored in the documentation direction called GUIDELINES.md

All API docs (scripts and prefabs) would have specific guidelines of how the docs would be written. All Getting started and tutorials would also include guidelines.

Any images required in documentation would need to be stored on github as github image links.

[andybak]

Just a reminder that I’m still (slowly) working on my “cookbook” approach to the docs. I’m finding it useful myself and I’ve validated they work so far with a someone else who was learning VRTK. Happy if anyone wants to contribute/criticise/steal/borrow

https://docs.google.com/document/d/1024kS1ZEOD21-UCcYNy2Ibsj6MRHBm3c241O-CIHrvk/edit?usp=sharing

[thestonefox]

Closing this as it’s related to an older version of VRTK (v3.3) the master branch is now on VRTK v4. Feel free to request to reopen if the issue is still present.