Layout of user manual

This is my proposal, I am yet to discuss this with someone else. The first todo here is to copy the texts from the wiki and format/paste them to the corresponding section
BlenderVR · Jan 22, 2015 · 8b587dc · 8b587dc
1 parent 2c5ed95
commit 8b587dc
Show file tree

Hide file tree

Showing 14 changed files with 139 additions and 1 deletion.
diff --git a/manual/architecture/index.rst b/manual/architecture/index.rst
@@ -0,0 +1,10 @@
+############
+Architecture
+############
+
+.. toctree::
+   :maxdepth: 1
+
+   master-slaves.rst
+   run-modes.rst
+   protocols.rst
diff --git a/manual/architecture/master-slaves.rst b/manual/architecture/master-slaves.rst
@@ -0,0 +1,11 @@
+=================
+Master and Slaves
+=================
+
+.. note ::
+
+  Document to be written.
+
+..
+  Copy from the wiki
+
diff --git a/manual/architecture/protocols.rst b/manual/architecture/protocols.rst
@@ -0,0 +1,11 @@
+=========
+Protocols
+=========
+
+.. note ::
+
+  Document to be written.
+
+..
+  Copy the content of the protocols.odt document.
+
diff --git a/manual/architecture/run-modes.rst b/manual/architecture/run-modes.rst
@@ -0,0 +1,11 @@
+=========
+Run Modes
+=========
+
+.. note ::
+
+  Document to be written.
+
+..
+  This is where we explain about the Console, the Update Loader and the Virtual Environment
+
diff --git a/manual/components/configuration-file.rst b/manual/components/configuration-file.rst
@@ -0,0 +1,10 @@
+==================
+Configuration File
+==================
+
+.. note ::
+
+  Document to be written.
+
+..
+  Explain the XML file and how to write it and examples.
diff --git a/manual/components/index.rst b/manual/components/index.rst
@@ -0,0 +1,12 @@
+##########
+How to Use
+##########
+
+.. toctree::
+   :maxdepth: 1
+
+   user-interface.rst
+   processor-file.rst
+   configuration-file.rst
+   vrpn.rst
+   osc.rst
diff --git a/manual/components/osc.rst b/manual/components/osc.rst
@@ -0,0 +1,10 @@
+========================
+Open Sound Control (OSC)
+========================
+
+.. note ::
+
+  Document to be written.
+
+..
+  Explain the OSC interface and how to use it
diff --git a/manual/components/processor-file.rst b/manual/components/processor-file.rst
@@ -0,0 +1,10 @@
+==============
+Processor File
+==============
+
+.. note ::
+
+  Document to be written.
+
+..
+  Explain the processor file and how to use it (eventually link to the API).
diff --git a/manual/components/user-interface.rst b/manual/components/user-interface.rst
@@ -0,0 +1,10 @@
+==============
+User Interface
+==============
+
+.. note ::
+
+  Document to be written.
+
+..
+  Show the options in the UI and what they do.
diff --git a/manual/components/vrpn.rst b/manual/components/vrpn.rst
@@ -0,0 +1,11 @@
+======================================
+Virtual Reality Private Network (VRPN)
+======================================
+
+.. note ::
+
+  Document to be written.
+
+..
+  Explain the VRPN interface and how to use it
+
diff --git a/manual/contents.rst b/manual/contents.rst
@@ -6,3 +6,7 @@
    :maxdepth: 1
 
    installation/index.rst
+   first-run.rst
+   components/index.rst
+   architecture/index.rst
+   development/index.rst
diff --git a/manual/development/index.rst b/manual/development/index.rst
@@ -0,0 +1,13 @@
+############
+Development
+############
+
+.. note ::
+
+  Document to be written.
+
+.. toctree::
+   :maxdepth: 1
+
+..
+  Talk about git, github, getting involved, ...
diff --git a/manual/first-run.rst b/manual/first-run.rst
@@ -0,0 +1,11 @@
+=========
+First Run
+=========
+
+.. note ::
+
+  Document to be written.
+
+..
+  Go over running the basic example just to make sure everything is working fine.
+
diff --git a/manual/index.rst b/manual/index.rst
@@ -3,6 +3,10 @@
 %%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    installation/index.rst
+   first-run.rst
+   components/index.rst
+   architecture/index.rst
+   development/index.rst