Add docs

[atirut-w]

The docs can be deployed to GH Pages by running mkdocs gh-deploy. A workflow to automatically regen and deploy docs can be added, but I have not done it yet on this PR (feel free to ask tho).

[atirut-w]

NOTE: Migration from README.md will start later.

[atirut-w]

Ah, right. What do I do with the old docs that are bunched up in README? Do I try to slim it down?

[atirut-w]

Now that I think about it, let's not merge this yet. I'd like to actually document the system calls, too.

[Zeal8bit]

@atirut-w Thanks for your help on that! Feel free to poke me for any further detail about the implementation or when this draft becomes ready to review

For the syscalls, the README explains them from the user application perspective, not driver/kernel perspective, if you think it would make sense to have another sections/chapter/part for that part, or even a subsection in driver part, feel free to add it

[atirut-w]

For the syscalls, the README explains them from the user application perspective, not driver/kernel perspective, if you think it would make sense to have another sections/chapter/part for that part, or even a subsection in driver part, feel free to add it

It's just that the readme only tell you the name, but doesn't go into enough details for some of the more specific syscalls like mount, directory operations, time format, etc. Now that there's a dedicated place for docs, I feel like it would be a disservice not to elaborate on them.

[atirut-w]

@Zeal8bit I'd like a review of the convention I used to document the system calls with (docs/system-calls.md). If they're okay, I can go ahead and do the rest.

[atirut-w]

New status: proofreading and feedback pending :)

[Zeal8bit]

Is there a way to separate the syscalls in a nice way? Can we integrate raw HTML code?
Does mkdocs allow us to make custom class for a markdown block?

[atirut-w]

There's a lot of customization you can do. IIRC there are detail HTML tags and horizontal bars in markdown, and Material for MkDocs provide a lot of their own stuff. Not quite sure which one to use, though.

[Zeal8bit]

@atirut-w Thanks a lot for your contribution! I love the design of the doc, I think you can integrate an automated task to deploy the pages.

I only left a single comment for the separating the syscalls but nothing very important

[atirut-w]

I think you can integrate an automated task to deploy the pages.

Indeed. I even made my own GH Action for it, but I'm not sure if it would be scope creep for this PR or if you would want to host it somewhere else other than GH Pages.

[Zeal8bit]

Thanks for your contribution, merging it!