An idea for organizing the documentation: A 3-section approach
Carlos Peralta <[email protected]> Sat, 2 May 2026 22:24:55 -0500
| Newsgroups | gmane.linux.debian.devel.documentation |
|---|---|
| Message-ID | <CAOE=6DtbPO3u423q9Ntxjm7h20eHmQ1Y+98qXNM_Yxju6QDUFQ@mail.gmail.com> |
--000000000000514a770650e15c6d Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable =E2=80=8BHi everyone, =E2=80=8BAs a new user getting involved in the project, I have been thinkin= g about how the documentation is presented. I would like to share an idea for structuring it into three main sections to make it more intuitive, especially for newcomers. =E2=80=8BHere is what I have in mind: =E2=80=8B1. Users Section This would be the starting point for anyone installing Debian. It could cover: =E2=80=8BInstallation: Step-by-step guides for both GUI and CLI (Command Li= ne Interface). A key addition would be explaining exactly what each command does during the CLI installation. =E2=80=8BSystem Management: Basic commands for updating the system, downloading/installing software, and how to properly add proprietary (non-free) software. =E2=80=8BTerminal Basics: A brief guide on how to navigate the terminal. =E2=80=8B2. Developers Section This section would dive into the technical side of the OS: =E2=80=8BDeep dive documentation into the Debian codebase. =E2=80=8BA comprehensive guide on how to create a custom distribution based= on Debian. =E2=80=8B3. Volunteers / Contributors Section A dedicated space to organize the community effort: =E2=80=8BA clear breakdown of the different areas that currently need help. =E2=80=8BAn explanation of what each area does and how to execute the tasks required. =E2=80=8BClear instructions or a sign-up process for those who want to supp= ort a specific team. =E2=80=8BI understand Debian already has a massive amount of documentation,= but I thought a unified structure like this could make the learning curve much smoother. =E2=80=8BI would love to hear your thoughts on this approach or if there is= already an ongoing effort similar to this that I can help with! =E2=80=8BBest regards, =E2=80=8BCarlos --000000000000514a770650e15c6d Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable <div dir=3D"auto">=E2=80=8BHi everyone,<div dir=3D"auto">=E2=80=8BAs a new = user getting involved in the project, I have been thinking about how the do= cumentation is presented. I would like to share an idea for structuring it = into three main sections to make it more intuitive, especially for newcomer= s.</div><div dir=3D"auto">=E2=80=8BHere is what I have in mind:</div><div d= ir=3D"auto">=E2=80=8B1. Users Section</div><div dir=3D"auto">This would be = the starting point for anyone installing Debian. It could cover:</div><div = dir=3D"auto">=E2=80=8BInstallation: Step-by-step guides for both GUI and CL= I (Command Line Interface). A key addition would be explaining exactly what= each command does during the CLI installation.</div><div dir=3D"auto">=E2= =80=8BSystem Management: Basic commands for updating the system, downloadin= g/installing software, and how to properly add proprietary (non-free) softw= are.</div><div dir=3D"auto">=E2=80=8BTerminal Basics: A brief guide on how = to navigate the terminal.</div><div dir=3D"auto">=E2=80=8B2. Developers Sec= tion</div><div dir=3D"auto">This section would dive into the technical side= of the OS:</div><div dir=3D"auto">=E2=80=8BDeep dive documentation into th= e Debian codebase.</div><div dir=3D"auto">=E2=80=8BA comprehensive guide on= how to create a custom distribution based on Debian.</div><div dir=3D"auto= ">=E2=80=8B3. Volunteers / Contributors Section</div><div dir=3D"auto">A de= dicated space to organize the community effort:</div><div dir=3D"auto">=E2= =80=8BA clear breakdown of the different areas that currently need help.</d= iv><div dir=3D"auto">=E2=80=8BAn explanation of what each area does and how= to execute the tasks required.</div><div dir=3D"auto">=E2=80=8BClear instr= uctions or a sign-up process for those who want to support a specific team.= </div><div dir=3D"auto">=E2=80=8BI understand Debian already has a massive = amount of documentation, but I thought a unified structure like this could = make the learning curve much smoother.</div><div dir=3D"auto">=E2=80=8BI wo= uld love to hear your thoughts on this approach or if there is already an o= ngoing effort similar to this that I can help with!</div><div dir=3D"auto">= =E2=80=8BBest regards,</div><div dir=3D"auto">=E2=80=8BCarlos</div></div> --000000000000514a770650e15c6d--