bitcraze#396 Reorganized documentation to tree structure

cafeciaojoe · Mar 22, 2020 · de15fc4 · de15fc4
1 parent 42770fb
commit de15fc4
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 20 deletions.
diff --git a/docs/_data/menu.yml b/docs/_data/menu.yml
@@ -1,5 +1,5 @@
 - page_id: home
-- title: Install Instructions
+- title: Installation
   subs:
     - {page_id: run_from_source}
     - {page_id: macports}
@@ -9,11 +9,11 @@
     - {page_id: cfheadless}
     - {page_id: inputdevices}
     - {page_id: raspberrypi}
-- title: Explanation Functionalities
+- title: Functional areas
   subs:
     - {page_id: cfloader}
     - {page_id: bootloaderclient}
     - {page_id: cfclient_zmq}
-- title: Development instructions
+- title: Development
   subs:
     - {page_id: dev_info_client}
diff --git a/docs/dev_info_client.md → docs/development/dev_info_client.md b/docs/dev_info_client.md → docs/development/dev_info_client.md
@@ -71,7 +71,7 @@ The input interfaces don\'t use any mapping, the devices itself directly
 generate useful values (like roll/pitch/yaw/thrust). Currently there\'s
 two implementations: LeapMotion and ZMQ. Values are read the same way as
 from normal gamepads/joysticks, at 100Hz. For more information on how
-the ZMQ interface works read [here](/cfclient_zmq#input-device).
+the ZMQ interface works read [here](/functional-areas/cfclient_zmq#input-device).
 
 ### The MUX
 

diff --git a/docs/cfclient_zmq.md → docs/functional-areas/cfclient_zmq.md b/docs/cfclient_zmq.md → docs/functional-areas/cfclient_zmq.md
@@ -4,7 +4,7 @@ page_id: cfclient_zmq
 ---
 
 
-The [Crazyflie Python client](/userguide_client/)
+The [Crazyflie Python client](/userguides/userguide_client/)
 runs a number of back-ends where you can set/get information from other
 applications via [ZMQ](http://zeromq.org/).
 
@@ -96,7 +96,7 @@ parameters, it\'s just the control part that\'s broken out.
 By default this is disabled in the configuration file and needs to be
 enabled. The configuration file parameter is named *enable\_zmq\_input*
 (see
-[this](/dev_info_client#user-configuration-file) to
+[this](/development/dev_info_client#user-configuration-file) to
 edit the configuration). To enable controlling by the back-end select
 the *ZMQ\@127.0.0.1:1212* input device in the *Input device* menu.
 
@@ -115,10 +115,10 @@ Available keys for the *ctrl* dictionary:
 
  | Field |   Range |  Unit        |     Comments|
 |---------|----------|----------------|---------------|
-|  roll  |   N/A    | degrees      |    
-|  pitch |   N/A    | degrees     |     
-|  yaw   |   N/A    | degrees/second |  
-|  thrust |  0-100  | Percent  |        
+|  roll  |   N/A    | degrees      |
+|  pitch |   N/A    | degrees     |
+|  yaw   |   N/A    | degrees/second |
+|  thrust |  0-100  | Percent  |
 |  estop  |  T/F    | boolean  |        Used to stop the Crazyflie and disable the control
 |  alt1  |   T/F    | boolean  |        Alt1 is internally mapped to functionality like switching LED-ring effect
 |  alt2   |  T/F    | boolean |         Alt2 is internally mapped to functionality like switching LED-ring headlights on/off

diff --git a/docs/cfloader.md → docs/functional-areas/cfloader.md b/docs/cfloader.md → docs/functional-areas/cfloader.md
diff --git a/docs/client.md → docs/functional-areas/client.md b/docs/client.md → docs/functional-areas/client.md
diff --git a/docs/macports.md → docs/installation/macports.md b/docs/macports.md → docs/installation/macports.md
diff --git a/docs/run_from_source.md → docs/installation/run_from_source.md b/docs/run_from_source.md → docs/installation/run_from_source.md
diff --git a/docs/cfheadless.md → docs/userguides/cfheadless.md b/docs/cfheadless.md → docs/userguides/cfheadless.md
diff --git a/docs/inputdevices.md → docs/userguides/inputdevices.md b/docs/inputdevices.md → docs/userguides/inputdevices.md
diff --git a/docs/raspberrypi.md → docs/userguides/raspberrypi.md b/docs/raspberrypi.md → docs/userguides/raspberrypi.md
diff --git a/docs/userguide_client.md → docs/userguides/userguide_client.md b/docs/userguide_client.md → docs/userguides/userguide_client.md
@@ -1,6 +1,6 @@
 ---
 title: Userguide cfclient GUI
-page_id: userguide_client 
+page_id: userguide_client
 ---
 
 
@@ -137,11 +137,11 @@ The procedure is described below and the parameters can be changed again
 any time the same way.
 
 
-|     **Crazyflie 1.0**                                                |                        **Crazyflie 2.0**  |                                                                                                                                
-|-----|------------|  
+|     **Crazyflie 1.0**                                                |                        **Crazyflie 2.0**  |
+|-----|------------|
 |   Click on the menu **\"Crazyflie-\>Configure 1.0\"** and then connect the bootloader by clicking on the \"cold boot\" button and by restarting the Crazyflie.  | First connect to the Crazyflie 2.0 with the normal connect button. Then open **\"Crazyflie-\>Configure 2.0\"** to reach the configure 2.0 dialog   |
- |    ![CF1 config](/images/configure_cf1.png){:width="500"}             |                                                                      ![CF2 config](/images/cfclient_cf2_config.png){:width="500"} |                                                            
-   |  Once the settings has been made press the program button to save them permanently in the Crazyflie flash.              |                                        Once the settings has been made press the write button to save them permanently in the Crazyflie 2.0 EEPROM.    |                                  
+ |    ![CF1 config](/images/configure_cf1.png){:width="500"}             |                                                                      ![CF2 config](/images/cfclient_cf2_config.png){:width="500"} |
+   |  Once the settings has been made press the program button to save them permanently in the Crazyflie flash.              |                                        Once the settings has been made press the write button to save them permanently in the Crazyflie 2.0 EEPROM.    |
 
 
 Logging
@@ -189,7 +189,7 @@ Input devices
 In order to control the Crazyflie you are connected to you will need
 some input-device. Normally this would be a gamepad, but any
 input-device with at least 4 analog axis will do. Here\'s [a
-list](/inputdevices/) of some input-devices
+list](/userguides/inputdevices/) of some input-devices
 that are used.
 
 In order to make sense of the input from the device a mapping has to be
@@ -407,7 +407,7 @@ starting/stopping again will yield two files in the same directory). The
 data logged to the file is in CSV format with the headers for the data
 at the top. A timestamp is automatically added for each entry and shows
 the number of milliseconds passed since the Crazyflie started (sent
-together with the log data). 
+together with the log data).
 
 Example data
 of what\'s logged when logging the battery level:
@@ -518,11 +518,11 @@ The UI is normally used to get/set parameters, view logged data and send
 control commands to the Crazyflie. Aside from this there\'s also the
 possibility to connect via ZMQ to the client and control several things:
 
--   [Parameters](/cfclient_zmq#parameters):
+-   [Parameters](/functional-areas/cfclient_zmq#parameters):
     Get/set parameters by name
--   [LED-ring memory](/cfclient_zmq#led-ring):
+-   [LED-ring memory](/functional-areas/cfclient_zmq#led-ring):
     Write LED ring memory
--   [Input-device](/cfclient_zmq#input-device):
+-   [Input-device](/functional-areas/cfclient_zmq#input-device):
     Act as an input device
 
 The benefit of using this approach instead of the [stand-alone ZMQ