diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index f3af6e4f..4e20fa93 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,20 @@ TeachOS Kernel Developer Documentation ====================================== +The *TeachOS Kernel Developer Documentation* contains developer documentation beyond the needs of an API documentation. +The API documentation, including internal and library APIs, can be found `here <https://teachos.pages.ost.ch/kernel/api/index.html>`_. + +The goal of the *TeachOS Kernel Developer Documentation* is to provide design overviews, technical briefs, and descriptions of the intended use of certain facilities in the codebase. +Additionally, this documentation provides information on topics such as how to implement device or filesystem drivers. + +Contents +======== + .. toctree:: :maxdepth: 2 - :caption: Contents: + design + guides briefs Indices and tables |