kerla
kerla copied to clipboard
nuta
Write Documentation
It would be helpful for interested contributors if kerla has some documentation. I would like to help with that. It will also help me understand kerla (and Operating Systems in general) better so that I can contribute with some code later on.
@nuta if possible can you suggest a rough outline of how you imagine the documentation to be structured? I can start working and send in some pull requests.
On that line, a document that is already there but might deserve some love is https://github.com/nuta/kerla/blob/main/COMPATIBILITY.md . All syscalls are marked as unimplemented, but as far as I know from what I read in the blog post, some of them are already available.
It would help to know what's there and what's not for others to contribute :) .
P.S.: Really cool work! P.S. (2): Not too much stuff, but I already started with it:
- https://github.com/nuta/kerla/pull/14
@nuta @castarco Any ideas on what I can contribute to further in the docs?
Also @nuta thanks for preparing the outline!
For a start, I thought maybe I can write some details about what has been implemented for the system calls which are labelled as "Partially" implemented in the notes column.
@yashrajkakkad I'm just an outsider, but what you said about improving information detail about syscalls seems like a good way to go. The current documentation is not entirely clear about what's missing when it comes to the partial implementations, as you said.
Wrote the architecture page: https://kerla.dev/docs/architecture.html
Please let me know if you have any ideas on other pages. I'll write them :)