Notes & Discussion 🔼
- The manual should be written in such a way that chapters may be read independently of each other.
- Make that concept clear to reader in the introduction. But how?
- don't explicitly advice skipping anything in a particular scenario (like: if you just want to install, don't read the history part)
- explain that while the chapters have been written [to be read] independently, they will only cover their specific topic and generaller not repeat info found in previous chapters, since that's what those are for. So, depending on your knowledge, you might run into problems when skipping chapters and may need to go back reding previous ones.
Structure 🔼
- Question: Do we need release-specific manuals (install manuals)like Debian has them? Asking about how these differ in #debian, I got this answer: "the parts where hardware or firmware, esp. boot firmware is different". "many systems can't boot from cd or usb media, others can't boot from network, some need media prepared with the specific model in mind", "some don't have serial consoles, some don't have graphic cards at all", "some only work if you provide crazy non-free firmware". -- msi
- Think about which parts are ok as subsections of a page and which ones need to be subpages.
- The tree structure not meant to imply the actual layout of how the documentation should always be presented. It must be written in a way that provides the possibility of taking out a chapter or page of that chapter and put it on Devuan's website, for example.
- add chapter Release notes/"Changelog" (In Debian, that contains a whole upgrade guide, which is maybe not the best way to go about it (cf. https://www.debian.org/releases/stable/i386/release-notes/).)
Abstract vs. about this manual 🔼
The abstract just breifly states what this manual is (about). The "About this manual" section also contains info on the way in which it has been written and why as well as hints on how to use it.
About Devuan 🔼
Explain the Devuan release model! (Explain what a point release is. (It's a maintenance release.))
- re-think the placing of the sectiongs/(sub-)chapters on Free Software and GNU+Linux