Updated documentation

markqvist · Jun 22, 2022 · 8f8da08 · 8f8da08
1 parent 01a973d
commit 8f8da08
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 62 deletions.
diff --git a/docs/Reticulum Manual.pdf b/docs/Reticulum Manual.pdf
diff --git a/docs/manual/_sources/hardware.rst.txt b/docs/manual/_sources/hardware.rst.txt
@@ -21,9 +21,13 @@ While this broad support and flexibility is very useful, an abundance of options
 can sometimes make it difficult to know where to begin, especially when you are
 starting from scratch.
 
-This chapter will outline a few different sensible easy starting paths to get
+This chapter will outline a few different sensible starting paths to get
 real-world functional wireless communications up and running with minimal cost
-and effort. Two fundamental devices types will be covered, *RNodes* and *WiFi-based radios*.
+and effort. Two fundamental devices categories will be covered, *RNodes* and
+*WiFi-based radios*. While there are many other device categories that are
+useful in building Reticulum networks, knowing how to just employ these two
+will make it possible to build a wide range of useful networks with little
+effort.
 
 .. _rnode-main:
 

diff --git a/docs/manual/_sources/index.rst.txt b/docs/manual/_sources/index.rst.txt
@@ -11,10 +11,10 @@ to participate in the development of Reticulum itself.
    whatis
    gettingstartedfast
    using
-   networks
-   interfaces
-   hardware
    understanding
+   hardware
+   interfaces
+   networks
    reference
    examples
    support

diff --git a/docs/manual/hardware.html b/docs/manual/hardware.html
@@ -16,8 +16,8 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Understanding Reticulum" href="understanding.html" />
-    <link rel="prev" title="Supported Interfaces" href="interfaces.html" /> 
+    <link rel="next" title="Supported Interfaces" href="interfaces.html" />
+    <link rel="prev" title="Understanding Reticulum" href="understanding.html" /> 
   </head><body>
     <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
@@ -26,10 +26,10 @@ <h3>Navigation</h3>
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="understanding.html" title="Understanding Reticulum"
+          <a href="interfaces.html" title="Supported Interfaces"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="interfaces.html" title="Supported Interfaces"
+          <a href="understanding.html" title="Understanding Reticulum"
              accesskey="P">previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.8 beta documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Communications Hardware</a></li> 
@@ -57,9 +57,13 @@ <h3>Navigation</h3>
 <p>While this broad support and flexibility is very useful, an abundance of options
 can sometimes make it difficult to know where to begin, especially when you are
 starting from scratch.</p>
-<p>This chapter will outline a few different sensible easy starting paths to get
+<p>This chapter will outline a few different sensible starting paths to get
 real-world functional wireless communications up and running with minimal cost
-and effort. Two fundamental devices types will be covered, <em>RNodes</em> and <em>WiFi-based radios</em>.</p>
+and effort. Two fundamental devices categories will be covered, <em>RNodes</em> and
+<em>WiFi-based radios</em>. While there are many other device categories that are
+useful in building Reticulum networks, knowing how to just employ these two
+will make it possible to build a wide range of useful networks with little
+effort.</p>
 <div class="section" id="rnode">
 <span id="rnode-main"></span><h2>RNode<a class="headerlink" href="#rnode" title="Permalink to this headline">¶</a></h2>
 <p>Reliable and general-purpose long-range digital radio transceiver systems are
@@ -265,11 +269,11 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 
   <h4>Previous topic</h4>
-  <p class="topless"><a href="interfaces.html"
-                        title="previous chapter">Supported Interfaces</a></p>
-  <h4>Next topic</h4>
   <p class="topless"><a href="understanding.html"
-                        title="next chapter">Understanding Reticulum</a></p>
+                        title="previous chapter">Understanding Reticulum</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="interfaces.html"
+                        title="next chapter">Supported Interfaces</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -298,10 +302,10 @@ <h3>Navigation</h3>
           <a href="genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="understanding.html" title="Understanding Reticulum"
+          <a href="interfaces.html" title="Supported Interfaces"
              >next</a> |</li>
         <li class="right" >
-          <a href="interfaces.html" title="Supported Interfaces"
+          <a href="understanding.html" title="Understanding Reticulum"
              >previous</a> |</li>
         <li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.8 beta documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Communications Hardware</a></li> 

diff --git a/docs/manual/index.html b/docs/manual/index.html
@@ -88,45 +88,6 @@ <h1>Reticulum Network Stack Manual<a class="headerlink" href="#reticulum-network
 </li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="networks.html#concepts-overview">Concepts &amp; Overview</a></li>
-<li class="toctree-l2"><a class="reference internal" href="networks.html#example-scenarios">Example Scenarios</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="networks.html#interconnected-lora-sites">Interconnected LoRa Sites</a></li>
-<li class="toctree-l3"><a class="reference internal" href="networks.html#bridging-over-the-internet">Bridging Over the Internet</a></li>
-<li class="toctree-l3"><a class="reference internal" href="networks.html#growth-and-convergence">Growth and Convergence</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Supported Interfaces</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#auto-interface">Auto Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#i2p-interface">I2P Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-server-interface">TCP Server Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-client-interface">TCP Client Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#udp-interface">UDP Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#rnode-lora-interface">RNode LoRa Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#serial-interface">Serial Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#pipe-interface">Pipe Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#kiss-interface">KISS Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#ax-25-kiss-interface">AX.25 KISS Interface</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#common-interface-options">Common Interface Options</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#interface-modes">Interface Modes</a></li>
-<li class="toctree-l2"><a class="reference internal" href="interfaces.html#announce-rate-control">Announce Rate Control</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="hardware.html#rnode">RNode</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="hardware.html#creating-rnodes">Creating RNodes</a></li>
-<li class="toctree-l3"><a class="reference internal" href="hardware.html#supported-boards">Supported Boards</a></li>
-<li class="toctree-l3"><a class="reference internal" href="hardware.html#installation">Installation</a></li>
-<li class="toctree-l3"><a class="reference internal" href="hardware.html#usage-with-reticulum">Usage with Reticulum</a></li>
-<li class="toctree-l3"><a class="reference internal" href="hardware.html#suppliers">Suppliers</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="hardware.html#wifi-based-hardware">WiFi-based Hardware</a></li>
-<li class="toctree-l2"><a class="reference internal" href="hardware.html#combining-hardware-types">Combining Hardware Types</a></li>
-</ul>
-</li>
 <li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="understanding.html#motivation">Motivation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="understanding.html#goals">Goals</a></li>
@@ -155,6 +116,45 @@ <h1>Reticulum Network Stack Manual<a class="headerlink" href="#reticulum-network
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="hardware.html#rnode">RNode</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="hardware.html#creating-rnodes">Creating RNodes</a></li>
+<li class="toctree-l3"><a class="reference internal" href="hardware.html#supported-boards">Supported Boards</a></li>
+<li class="toctree-l3"><a class="reference internal" href="hardware.html#installation">Installation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="hardware.html#usage-with-reticulum">Usage with Reticulum</a></li>
+<li class="toctree-l3"><a class="reference internal" href="hardware.html#suppliers">Suppliers</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="hardware.html#wifi-based-hardware">WiFi-based Hardware</a></li>
+<li class="toctree-l2"><a class="reference internal" href="hardware.html#combining-hardware-types">Combining Hardware Types</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Supported Interfaces</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#auto-interface">Auto Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#i2p-interface">I2P Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-server-interface">TCP Server Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-client-interface">TCP Client Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#udp-interface">UDP Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#rnode-lora-interface">RNode LoRa Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#serial-interface">Serial Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#pipe-interface">Pipe Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#kiss-interface">KISS Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#ax-25-kiss-interface">AX.25 KISS Interface</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#common-interface-options">Common Interface Options</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#interface-modes">Interface Modes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="interfaces.html#announce-rate-control">Announce Rate Control</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="networks.html#concepts-overview">Concepts &amp; Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="networks.html#example-scenarios">Example Scenarios</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="networks.html#interconnected-lora-sites">Interconnected LoRa Sites</a></li>
+<li class="toctree-l3"><a class="reference internal" href="networks.html#bridging-over-the-internet">Bridging Over the Internet</a></li>
+<li class="toctree-l3"><a class="reference internal" href="networks.html#growth-and-convergence">Growth and Convergence</a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="reference.html#classes">Classes</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="reference.html#reticulum">Reticulum</a></li>

diff --git a/docs/manual/searchindex.js b/docs/manual/searchindex.js
diff --git a/docs/source/hardware.rst b/docs/source/hardware.rst
@@ -21,9 +21,13 @@ While this broad support and flexibility is very useful, an abundance of options
 can sometimes make it difficult to know where to begin, especially when you are
 starting from scratch.
 
-This chapter will outline a few different sensible easy starting paths to get
+This chapter will outline a few different sensible starting paths to get
 real-world functional wireless communications up and running with minimal cost
-and effort. Two fundamental devices types will be covered, *RNodes* and *WiFi-based radios*.
+and effort. Two fundamental devices categories will be covered, *RNodes* and
+*WiFi-based radios*. While there are many other device categories that are
+useful in building Reticulum networks, knowing how to just employ these two
+will make it possible to build a wide range of useful networks with little
+effort.
 
 .. _rnode-main:
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,10 +11,10 @@ to participate in the development of Reticulum itself.
    whatis
    gettingstartedfast
    using
-   networks
-   interfaces
-   hardware
    understanding
+   hardware
+   interfaces
+   networks
    reference
    examples
    support