Skip to content

Commit 75c6248

Browse files
markqvistmarkqvist
committed
Updated documentation
1 parent 9294ab4 commit 75c6248

22 files changed

+59
-46
lines changed

‎Changelog.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
### 2023-05-19: RNS β 0.5.3
2+
3+
This maintenance release brings a single, but important bugfix.
4+
5+
**Changes**
6+
- Fixed a bug that could cause data corruption to occur over when using `Buffer` instances.
7+
8+
**Release Hashes**
9+
```
10+
11+
```
12+
113
### 2023-05-12: RNS β 0.5.2
214

315
This maintenance release brings a number of bugfixes and improvements.

‎Roadmap.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ This document outlines the currently established development roadmap for Reticul
1515
For each release cycle of Reticulum, improvements and additions from the five [Primary Efforts](#primary-efforts) are selected as active work areas, and can be expected to be included in the upcoming releases within that cycle. While not entirely set in stone for each release cycle, they serve as a pointer of what to expect in the near future.
1616

1717
- The current `0.5.x` release cycle aims at completing
18+
- [x] Reach feature-completion of the Reticulum API
19+
- [x] Improve performance and efficiency of the `Buffer` and `Channel` API
1820
- [ ] Overhauling and updating the documentation
1921
- [ ] Performance and memory optimisations of the Python reference implementation
2022
- [ ] Fixing potential bugs
2123
- [ ] Add automatic retries to all use cases of the `Request` API
22-
- [ ] Improve performance and efficiency of the `Buffer` and `Channel` API
2324

2425
## Primary Efforts
2526
The development path for Reticulum is currently laid out in five distinct areas: *Comprehensibility*, *Universality*, *Functionality*, *Usability & Utility* and *Interfaceability*. Conceptualising the development of Reticulum into these areas serves to advance the implementation and work towards the Foundational Goals & Values of Reticulum.

‎docs/Reticulum Manual.epub

1 Byte
Binary file not shown.

‎docs/Reticulum Manual.pdf

97 Bytes
Binary file not shown.

‎docs/manual/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: c5670e7931d15fbef274e2eee17c3561
3+
config: 7638eb217b32841965cb99f2db5009a6
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/manual/_static/documentation_options.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '0.5.2 beta',
3+
VERSION: '0.5.3 beta',
44
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/manual/examples.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Support Reticulum" href="support.html" /><link rel="prev" title="Building Networks" href="networks.html" />
77

88
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/>
9-
<title>Code Examples - Reticulum Network Stack 0.5.2 beta documentation</title>
9+
<title>Code Examples - Reticulum Network Stack 0.5.3 beta documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -141,7 +141,7 @@
141141
</label>
142142
</div>
143143
<div class="header-center">
144-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
144+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
145145
</div>
146146
<div class="header-right">
147147
<div class="theme-toggle-container theme-toggle-header">
@@ -167,7 +167,7 @@
167167
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
168168
</div>
169169

170-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
170+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
171171

172172
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
173173
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/forhumans.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
77

88
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/>
9-
<title>An Explanation of Reticulum for Human Beings - Reticulum Network Stack 0.5.2 beta documentation</title>
9+
<title>An Explanation of Reticulum for Human Beings - Reticulum Network Stack 0.5.3 beta documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -141,7 +141,7 @@
141141
</label>
142142
</div>
143143
<div class="header-center">
144-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
144+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
145145
</div>
146146
<div class="header-right">
147147
<div class="theme-toggle-container theme-toggle-header">
@@ -167,7 +167,7 @@
167167
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
168168
</div>
169169

170-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
170+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
171171

172172
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
173173
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/genindex.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
66

7-
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/><title>Index - Reticulum Network Stack 0.5.2 beta documentation</title>
7+
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/><title>Index - Reticulum Network Stack 0.5.3 beta documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
99
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1010
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -139,7 +139,7 @@
139139
</label>
140140
</div>
141141
<div class="header-center">
142-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
142+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
143143
</div>
144144
<div class="header-right">
145145
<div class="theme-toggle-container theme-toggle-header">
@@ -165,7 +165,7 @@
165165
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
166166
</div>
167167

168-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
168+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
169169

170170
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
171171
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/gettingstartedfast.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Using Reticulum on Your System" href="using.html" /><link rel="prev" title="What is Reticulum?" href="whatis.html" />
77

88
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/>
9-
<title>Getting Started Fast - Reticulum Network Stack 0.5.2 beta documentation</title>
9+
<title>Getting Started Fast - Reticulum Network Stack 0.5.3 beta documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -141,7 +141,7 @@
141141
</label>
142142
</div>
143143
<div class="header-center">
144-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
144+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
145145
</div>
146146
<div class="header-right">
147147
<div class="theme-toggle-container theme-toggle-header">
@@ -167,7 +167,7 @@
167167
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
168168
</div>
169169

170-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
170+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
171171

172172
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
173173
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/hardware.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Supported Interfaces" href="interfaces.html" /><link rel="prev" title="Understanding Reticulum" href="understanding.html" />
77

88
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/>
9-
<title>Communications Hardware - Reticulum Network Stack 0.5.2 beta documentation</title>
9+
<title>Communications Hardware - Reticulum Network Stack 0.5.3 beta documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -141,7 +141,7 @@
141141
</label>
142142
</div>
143143
<div class="header-center">
144-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
144+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
145145
</div>
146146
<div class="header-right">
147147
<div class="theme-toggle-container theme-toggle-header">
@@ -167,7 +167,7 @@
167167
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
168168
</div>
169169

170-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
170+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
171171

172172
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
173173
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="What is Reticulum?" href="whatis.html" />
77

88
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/>
9-
<title>Reticulum Network Stack 0.5.2 beta documentation</title>
9+
<title>Reticulum Network Stack 0.5.3 beta documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -141,7 +141,7 @@
141141
</label>
142142
</div>
143143
<div class="header-center">
144-
<a href="#"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
144+
<a href="#"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
145145
</div>
146146
<div class="header-right">
147147
<div class="theme-toggle-container theme-toggle-header">
@@ -167,7 +167,7 @@
167167
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
168168
</div>
169169

170-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
170+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
171171

172172
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
173173
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/interfaces.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Building Networks" href="networks.html" /><link rel="prev" title="Communications Hardware" href="hardware.html" />
77

88
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/>
9-
<title>Supported Interfaces - Reticulum Network Stack 0.5.2 beta documentation</title>
9+
<title>Supported Interfaces - Reticulum Network Stack 0.5.3 beta documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -141,7 +141,7 @@
141141
</label>
142142
</div>
143143
<div class="header-center">
144-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
144+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
145145
</div>
146146
<div class="header-right">
147147
<div class="theme-toggle-container theme-toggle-header">
@@ -167,7 +167,7 @@
167167
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
168168
</div>
169169

170-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
170+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
171171

172172
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
173173
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/networks.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Code Examples" href="examples.html" /><link rel="prev" title="Supported Interfaces" href="interfaces.html" />
77

88
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/>
9-
<title>Building Networks - Reticulum Network Stack 0.5.2 beta documentation</title>
9+
<title>Building Networks - Reticulum Network Stack 0.5.3 beta documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -141,7 +141,7 @@
141141
</label>
142142
</div>
143143
<div class="header-center">
144-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
144+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
145145
</div>
146146
<div class="header-right">
147147
<div class="theme-toggle-container theme-toggle-header">
@@ -167,7 +167,7 @@
167167
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
168168
</div>
169169

170-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
170+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
171171

172172
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
173173
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/objects.inv

0 Bytes
Binary file not shown.

‎docs/manual/reference.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Support Reticulum" href="support.html" />
77

88
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/>
9-
<title>API Reference - Reticulum Network Stack 0.5.2 beta documentation</title>
9+
<title>API Reference - Reticulum Network Stack 0.5.3 beta documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
1111
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -141,7 +141,7 @@
141141
</label>
142142
</div>
143143
<div class="header-center">
144-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
144+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
145145
</div>
146146
<div class="header-right">
147147
<div class="theme-toggle-container theme-toggle-header">
@@ -167,7 +167,7 @@
167167
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
168168
</div>
169169

170-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
170+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
171171

172172
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
173173
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/search.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="#" />
66

7-
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/><title>Search - Reticulum Network Stack 0.5.2 beta documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
7+
<meta name="generator" content="sphinx-5.2.2, furo 2022.09.29"/><title>Search - Reticulum Network Stack 0.5.3 beta documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
88
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
99
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
1010
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -138,7 +138,7 @@
138138
</label>
139139
</div>
140140
<div class="header-center">
141-
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.2 beta documentation</div></a>
141+
<a href="index.html"><div class="brand">Reticulum Network Stack 0.5.3 beta documentation</div></a>
142142
</div>
143143
<div class="header-right">
144144
<div class="theme-toggle-container theme-toggle-header">
@@ -164,7 +164,7 @@
164164
<img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
165165
</div>
166166

167-
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.2 beta documentation</span>
167+
<span class="sidebar-brand-text">Reticulum Network Stack 0.5.3 beta documentation</span>
168168

169169
</a><form class="sidebar-search-container" method="get" action="#" role="search">
170170
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

‎docs/manual/searchindex.js

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

0 commit comments

Comments
 (0)