Serenity: Documentation Request

[Arthur-Kamau]

Documentation is critical to any system.
Well maintained documentation helps a few things:

• Assists new members by enabling them to quickly go through the system details.
• Facilitates existing members to learn more about different parts of the system.
• Among other things.

This is more of an inquiry, could somethings like read the docs be integrated into serenity os github repository. If it's okay I would be more than happy to create a pull request and welcome the army of documentation builder to improve on the documentation coverage

[zlotny]

Kind of related to #1344 (that's more about specific library documentation).

I remember seeing some thread (or even in a video?) in which the nature of the _ever changing system_ was discussed, so documentation would be a bit complicated as things change and move pretty quickly.

However there's a lot of things that don't usually change a lot (like the system architecture and how it's built from the ground up). I assume a wiki documentation and guide would be welcome.

Let's @awesomekling decide on this :)

[bugaevc]

Why do you guys talk about it as if we don't have documentation? :wink:

[Arthur-Kamau]

Yes that true there are the man pages , the unfortunate thing is that i have to spin up a serenity session, to read the docs, what if they could be hosted on the serenity os git hib pages.
Where even on a commute you could read it through your phone.
@zlotny you could assign @awesomekling this issue.

[bugaevc]

the unfortunate thing is that i have to spin up a serenity session

How come it's an unfortunate thing? 😀

what if they could be hosted on the serenity os git hib pages. Where even on a commute you could read it through your phone.

😉 https://github.com/SerenityOS/serenity/tree/master/Base/usr/share/man 😉

[Arthur-Kamau]

That was fast, anyways just thought it would be a good idea as newbies could just visit the wiki or the repo page no need to traverse the repo directory structure to access the documentation.

will go ahead an close the issue.😀

[Arthur-Kamau]

And since the Documentation is in markdown, it would be easy to host it in the wiki or github pages.

[bgianfo]

I like the idea of leveraging the existing docs/man pages so they are more easily visible outside of serenity.

A simple first step would be creating links in ReadMe.md to the Base/usr/share/man, so you
can easily jump to the available documentation when browsing the github repo.