osOS Documentation

Welcome! This is the landing page for the documentation of my osOS kernel pet project.

Checkout the README file in the source repo for a view into the goals and reasoning behind this project. Spoiler alert: it's fun and educational!

The docs themselves are generated by the zig build system, this page is just a landing page to glue them all together in one neat home since the kernel has many different modules, each with different generated docs and their own home page.

Each entry point also may (or may not, for example, in the RISCV-32 kernel yet) have some architecture specific modules they use. Those will also have their own documentation home page. Here are the docs:

• x86 Kernel Documentation Home Page
  • x86 Memory Module
  • x86 Assembly Module
• RISC-V32 Kernel Documentation Home Page

There is some generic "architecture-agnostic" code that can be used by any part of the kernel. This includes things like int to string conversion and kernel definitions like Processes. The documentation for these modules are also available:

• OSFormat Module
• OSProcess Module
• OSMemory Module

Of course, if you would like to check out the source, you can check out the repo hosted on github:

• Source Repo

Github stars are appreciated! But of course, they are not required.