Skip to content

Commit 8f8da08

Browse files
markqvistmarkqvist
committed
Updated documentation
1 parent 01a973d commit 8f8da08

8 files changed

+74
-62
lines changed

‎docs/Reticulum Manual.pdf

100 Bytes
Binary file not shown.

‎docs/manual/_sources/hardware.rst.txt

+6-2
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ While this broad support and flexibility is very useful, an abundance of options
2121
can sometimes make it difficult to know where to begin, especially when you are
2222
starting from scratch.
2323

24-
This chapter will outline a few different sensible easy starting paths to get
24+
This chapter will outline a few different sensible starting paths to get
2525
real-world functional wireless communications up and running with minimal cost
26-
and effort. Two fundamental devices types will be covered, *RNodes* and *WiFi-based radios*.
26+
and effort. Two fundamental devices categories will be covered, *RNodes* and
27+
*WiFi-based radios*. While there are many other device categories that are
28+
useful in building Reticulum networks, knowing how to just employ these two
29+
will make it possible to build a wide range of useful networks with little
30+
effort.
2731

2832
.. _rnode-main:
2933

‎docs/manual/_sources/index.rst.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ to participate in the development of Reticulum itself.
1111
whatis
1212
gettingstartedfast
1313
using
14-
networks
15-
interfaces
16-
hardware
1714
understanding
15+
hardware
16+
interfaces
17+
networks
1818
reference
1919
examples
2020
support

‎docs/manual/hardware.html

+16-12
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616

1717
<link rel="index" title="Index" href="genindex.html" />
1818
<link rel="search" title="Search" href="search.html" />
19-
<link rel="next" title="Understanding Reticulum" href="understanding.html" />
20-
<link rel="prev" title="Supported Interfaces" href="interfaces.html" />
19+
<link rel="next" title="Supported Interfaces" href="interfaces.html" />
20+
<link rel="prev" title="Understanding Reticulum" href="understanding.html" />
2121
</head><body>
2222
<div class="related" role="navigation" aria-label="related navigation">
2323
<h3>Navigation</h3>
@@ -26,10 +26,10 @@ <h3>Navigation</h3>
2626
<a href="genindex.html" title="General Index"
2727
accesskey="I">index</a></li>
2828
<li class="right" >
29-
<a href="understanding.html" title="Understanding Reticulum"
29+
<a href="interfaces.html" title="Supported Interfaces"
3030
accesskey="N">next</a> |</li>
3131
<li class="right" >
32-
<a href="interfaces.html" title="Supported Interfaces"
32+
<a href="understanding.html" title="Understanding Reticulum"
3333
accesskey="P">previous</a> |</li>
3434
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.8 beta documentation</a> &#187;</li>
3535
<li class="nav-item nav-item-this"><a href="">Communications Hardware</a></li>
@@ -57,9 +57,13 @@ <h3>Navigation</h3>
5757
<p>While this broad support and flexibility is very useful, an abundance of options
5858
can sometimes make it difficult to know where to begin, especially when you are
5959
starting from scratch.</p>
60-
<p>This chapter will outline a few different sensible easy starting paths to get
60+
<p>This chapter will outline a few different sensible starting paths to get
6161
real-world functional wireless communications up and running with minimal cost
62-
and effort. Two fundamental devices types will be covered, <em>RNodes</em> and <em>WiFi-based radios</em>.</p>
62+
and effort. Two fundamental devices categories will be covered, <em>RNodes</em> and
63+
<em>WiFi-based radios</em>. While there are many other device categories that are
64+
useful in building Reticulum networks, knowing how to just employ these two
65+
will make it possible to build a wide range of useful networks with little
66+
effort.</p>
6367
<div class="section" id="rnode">
6468
<span id="rnode-main"></span><h2>RNode<a class="headerlink" href="#rnode" title="Permalink to this headline"></a></h2>
6569
<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>
265269
</ul>
266270

267271
<h4>Previous topic</h4>
268-
<p class="topless"><a href="interfaces.html"
269-
title="previous chapter">Supported Interfaces</a></p>
270-
<h4>Next topic</h4>
271272
<p class="topless"><a href="understanding.html"
272-
title="next chapter">Understanding Reticulum</a></p>
273+
title="previous chapter">Understanding Reticulum</a></p>
274+
<h4>Next topic</h4>
275+
<p class="topless"><a href="interfaces.html"
276+
title="next chapter">Supported Interfaces</a></p>
273277
<div role="note" aria-label="source link">
274278
<h3>This Page</h3>
275279
<ul class="this-page-menu">
@@ -298,10 +302,10 @@ <h3>Navigation</h3>
298302
<a href="genindex.html" title="General Index"
299303
>index</a></li>
300304
<li class="right" >
301-
<a href="understanding.html" title="Understanding Reticulum"
305+
<a href="interfaces.html" title="Supported Interfaces"
302306
>next</a> |</li>
303307
<li class="right" >
304-
<a href="interfaces.html" title="Supported Interfaces"
308+
<a href="understanding.html" title="Understanding Reticulum"
305309
>previous</a> |</li>
306310
<li class="nav-item nav-item-0"><a href="index.html">Reticulum Network Stack 0.3.8 beta documentation</a> &#187;</li>
307311
<li class="nav-item nav-item-this"><a href="">Communications Hardware</a></li>

‎docs/manual/index.html

+39-39
Original file line numberDiff line numberDiff line change
@@ -88,45 +88,6 @@ <h1>Reticulum Network Stack Manual<a class="headerlink" href="#reticulum-network
8888
</li>
8989
</ul>
9090
</li>
91-
<li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a><ul>
92-
<li class="toctree-l2"><a class="reference internal" href="networks.html#concepts-overview">Concepts &amp; Overview</a></li>
93-
<li class="toctree-l2"><a class="reference internal" href="networks.html#example-scenarios">Example Scenarios</a><ul>
94-
<li class="toctree-l3"><a class="reference internal" href="networks.html#interconnected-lora-sites">Interconnected LoRa Sites</a></li>
95-
<li class="toctree-l3"><a class="reference internal" href="networks.html#bridging-over-the-internet">Bridging Over the Internet</a></li>
96-
<li class="toctree-l3"><a class="reference internal" href="networks.html#growth-and-convergence">Growth and Convergence</a></li>
97-
</ul>
98-
</li>
99-
</ul>
100-
</li>
101-
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Supported Interfaces</a><ul>
102-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#auto-interface">Auto Interface</a></li>
103-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#i2p-interface">I2P Interface</a></li>
104-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-server-interface">TCP Server Interface</a></li>
105-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-client-interface">TCP Client Interface</a></li>
106-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#udp-interface">UDP Interface</a></li>
107-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#rnode-lora-interface">RNode LoRa Interface</a></li>
108-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#serial-interface">Serial Interface</a></li>
109-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#pipe-interface">Pipe Interface</a></li>
110-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#kiss-interface">KISS Interface</a></li>
111-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#ax-25-kiss-interface">AX.25 KISS Interface</a></li>
112-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#common-interface-options">Common Interface Options</a></li>
113-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#interface-modes">Interface Modes</a></li>
114-
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#announce-rate-control">Announce Rate Control</a></li>
115-
</ul>
116-
</li>
117-
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a><ul>
118-
<li class="toctree-l2"><a class="reference internal" href="hardware.html#rnode">RNode</a><ul>
119-
<li class="toctree-l3"><a class="reference internal" href="hardware.html#creating-rnodes">Creating RNodes</a></li>
120-
<li class="toctree-l3"><a class="reference internal" href="hardware.html#supported-boards">Supported Boards</a></li>
121-
<li class="toctree-l3"><a class="reference internal" href="hardware.html#installation">Installation</a></li>
122-
<li class="toctree-l3"><a class="reference internal" href="hardware.html#usage-with-reticulum">Usage with Reticulum</a></li>
123-
<li class="toctree-l3"><a class="reference internal" href="hardware.html#suppliers">Suppliers</a></li>
124-
</ul>
125-
</li>
126-
<li class="toctree-l2"><a class="reference internal" href="hardware.html#wifi-based-hardware">WiFi-based Hardware</a></li>
127-
<li class="toctree-l2"><a class="reference internal" href="hardware.html#combining-hardware-types">Combining Hardware Types</a></li>
128-
</ul>
129-
</li>
13091
<li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a><ul>
13192
<li class="toctree-l2"><a class="reference internal" href="understanding.html#motivation">Motivation</a></li>
13293
<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
155116
</li>
156117
</ul>
157118
</li>
119+
<li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a><ul>
120+
<li class="toctree-l2"><a class="reference internal" href="hardware.html#rnode">RNode</a><ul>
121+
<li class="toctree-l3"><a class="reference internal" href="hardware.html#creating-rnodes">Creating RNodes</a></li>
122+
<li class="toctree-l3"><a class="reference internal" href="hardware.html#supported-boards">Supported Boards</a></li>
123+
<li class="toctree-l3"><a class="reference internal" href="hardware.html#installation">Installation</a></li>
124+
<li class="toctree-l3"><a class="reference internal" href="hardware.html#usage-with-reticulum">Usage with Reticulum</a></li>
125+
<li class="toctree-l3"><a class="reference internal" href="hardware.html#suppliers">Suppliers</a></li>
126+
</ul>
127+
</li>
128+
<li class="toctree-l2"><a class="reference internal" href="hardware.html#wifi-based-hardware">WiFi-based Hardware</a></li>
129+
<li class="toctree-l2"><a class="reference internal" href="hardware.html#combining-hardware-types">Combining Hardware Types</a></li>
130+
</ul>
131+
</li>
132+
<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Supported Interfaces</a><ul>
133+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#auto-interface">Auto Interface</a></li>
134+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#i2p-interface">I2P Interface</a></li>
135+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-server-interface">TCP Server Interface</a></li>
136+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#tcp-client-interface">TCP Client Interface</a></li>
137+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#udp-interface">UDP Interface</a></li>
138+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#rnode-lora-interface">RNode LoRa Interface</a></li>
139+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#serial-interface">Serial Interface</a></li>
140+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#pipe-interface">Pipe Interface</a></li>
141+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#kiss-interface">KISS Interface</a></li>
142+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#ax-25-kiss-interface">AX.25 KISS Interface</a></li>
143+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#common-interface-options">Common Interface Options</a></li>
144+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#interface-modes">Interface Modes</a></li>
145+
<li class="toctree-l2"><a class="reference internal" href="interfaces.html#announce-rate-control">Announce Rate Control</a></li>
146+
</ul>
147+
</li>
148+
<li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a><ul>
149+
<li class="toctree-l2"><a class="reference internal" href="networks.html#concepts-overview">Concepts &amp; Overview</a></li>
150+
<li class="toctree-l2"><a class="reference internal" href="networks.html#example-scenarios">Example Scenarios</a><ul>
151+
<li class="toctree-l3"><a class="reference internal" href="networks.html#interconnected-lora-sites">Interconnected LoRa Sites</a></li>
152+
<li class="toctree-l3"><a class="reference internal" href="networks.html#bridging-over-the-internet">Bridging Over the Internet</a></li>
153+
<li class="toctree-l3"><a class="reference internal" href="networks.html#growth-and-convergence">Growth and Convergence</a></li>
154+
</ul>
155+
</li>
156+
</ul>
157+
</li>
158158
<li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a><ul>
159159
<li class="toctree-l2"><a class="reference internal" href="reference.html#classes">Classes</a><ul>
160160
<li class="toctree-l3"><a class="reference internal" href="reference.html#reticulum">Reticulum</a></li>

‎docs/manual/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/source/hardware.rst

+6-2
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ While this broad support and flexibility is very useful, an abundance of options
2121
can sometimes make it difficult to know where to begin, especially when you are
2222
starting from scratch.
2323

24-
This chapter will outline a few different sensible easy starting paths to get
24+
This chapter will outline a few different sensible starting paths to get
2525
real-world functional wireless communications up and running with minimal cost
26-
and effort. Two fundamental devices types will be covered, *RNodes* and *WiFi-based radios*.
26+
and effort. Two fundamental devices categories will be covered, *RNodes* and
27+
*WiFi-based radios*. While there are many other device categories that are
28+
useful in building Reticulum networks, knowing how to just employ these two
29+
will make it possible to build a wide range of useful networks with little
30+
effort.
2731

2832
.. _rnode-main:
2933

‎docs/source/index.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ to participate in the development of Reticulum itself.
1111
whatis
1212
gettingstartedfast
1313
using
14-
networks
15-
interfaces
16-
hardware
1714
understanding
15+
hardware
16+
interfaces
17+
networks
1818
reference
1919
examples
2020
support

0 commit comments

Comments
 (0)