search

Zeal8bit / Zeal-8-bit-OS

An Operating System for Z80 computers, written in assembly
Apache License 2.0
574 stars 54 forks source link

Add docs #34

Closed atirut-w closed 1 month ago

atirut-w commented 4 months ago

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 commented 4 months ago

NOTE: Migration from README.md will start later.

atirut-w commented 4 months ago

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 commented 4 months ago

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

Zeal8bit commented 4 months ago

@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 commented 4 months ago

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 commented 3 months ago

@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 commented 2 months ago

New status: proofreading and feedback pending :)

Zeal8bit commented 2 months ago

@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 commented 2 months ago

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 commented 1 month ago

Thanks for your contribution, merging it!