From a8032daf68bc6ff7e345c7ef328252c34e64c599 Mon Sep 17 00:00:00 2001 From: Felix Morgner Date: Mon, 31 Aug 2026 21:45:29 +0200 Subject: docs: update documentation structure --- docs/index.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'docs/index.rst') 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 `_. + +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 -- cgit v1.2.3