aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2026-08-31 21:45:29 +0200
committerFelix Morgner <felix.morgner@ost.ch>2026-08-31 21:45:29 +0200
commita8032daf68bc6ff7e345c7ef328252c34e64c599 (patch)
treee34ff0e68ccb0ddec6ad3b39c24556738a4344b0 /docs/index.rst
parent3003febdaa0c8b109e56b6c964ae4ee8076b41c1 (diff)
downloadkernel-a8032daf68bc6ff7e345c7ef328252c34e64c599.tar.xz
kernel-a8032daf68bc6ff7e345c7ef328252c34e64c599.zip
docs: update documentation structure
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst12
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