Documentation Overhaul #256
Replies: 3 comments 3 replies
-
|
Section 1, whatis.rst Areas that need updatesThis is where content changes may need to occur:
|
Beta Was this translation helpful? Give feedback.
-
Section 2: Getting Started FastCurrent page: https://markqvist.github.io/Reticulum/manual/gettingstartedfast.html Areas that need updatesStandalone Reticulum InstallationPotentially move the paragraph on installing pip to the end of the section. Resolving Dependencies and Installation IssuesRefactor this into a subheading under "Standalone installation"? It seems to be mostly pertinent to this section. Reticulum-based appsMention that Sideband doesn't yet have full feature parity with NomadNet? Included Utilities--Participate in developmentI would refactor all seven of these headings into its own note, linked back to the "standalone installation" section. On the whole I think this piece of documentation is well-written and needs just a little refactoring. I am not in a position to comment on completeness, but as it is a quick-start guide the goal is expediency and not 100% coverage. |
Beta Was this translation helpful? Give feedback.
-
Is it supposed to? Sideband has a few intended features (like local map) that I don't see as part of NomadNet, and I don't think Sideband is meant to run a propagation node or serve pages. |
Beta Was this translation helpful? Give feedback.
-
|
Nope, it is not. It's intended as a more basic, messaging-oriented app. A nomadnet page-browser would be nice for Android, but I think it is better suited as a separate app. |
Beta Was this translation helpful? Give feedback.
-
|
No, it isn't necessarily supposed to be so. This could probably use a mention. |
Beta Was this translation helpful? Give feedback.
-
Section 3: Using Reticulum On Your SystemThis section of the docs is very clear. Aside from general updates and currency-checking I think it is good. I notice that in this commit there's a few updates for the version numbers. The top level paragraphs are not clear that Reticulum can be run as a daemon through UtilitiesI love how each utility is compared to a conventional IP-based utility, it helps tie in what the reader already (possibly) understands. Also, the second paragraph directly under the header is about the |
Beta Was this translation helpful? Give feedback.
-
Hello all!
First off, I'm super excited about Reticulum! This project is awesome and the people behind it are awesome.
@markqvist as per your reply on Reticulum I've started to look over the existing manual and suggest changes/take notes on needed updates.
Everywhere I can I have created commits that could be pulled into the main branch. I expect as I go along I will find sections that I don't understand.
Those I will leave to the experienced developers, though I hope to learn enough to be able to contribute more.
My set of changes lives here:
https://github.com/Neo-J-A/Reticulum_Docs_Improvement
For each page (or possibly section) of the manual, I will create a comment in this discussion with my thoughts on it and a pull request with my proposed changes.
Most changes I suggest will be formal rather than functional until I develop an intimate working knowledge of the project.
They are intended to make reading documentation as easy and fun as possible.
My goal with this is to support the lead developers by reducing documentation load and allowing those with more experience to focus on content over form. If mark or others would rather not see the noise I will refrain from making pull-requests until all the documentation is complete and reviewed.
Beta Was this translation helpful? Give feedback.
All reactions