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/briefs.rst | 2 +- docs/conf.py | 4 ++-- docs/design.rst | 2 ++ docs/guides.rst | 9 +++++++++ docs/guides/device-drivers.rst | 2 ++ docs/index.rst | 12 +++++++++++- 6 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 docs/design.rst create mode 100644 docs/guides.rst create mode 100644 docs/guides/device-drivers.rst (limited to 'docs') diff --git a/docs/briefs.rst b/docs/briefs.rst index 19313459..36d4c19e 100644 --- a/docs/briefs.rst +++ b/docs/briefs.rst @@ -3,7 +3,7 @@ Technical Briefs .. toctree:: :maxdepth: 1 - :caption: Contents: + :caption: Contents :glob: briefs/* diff --git a/docs/conf.py b/docs/conf.py index 37838427..5ff02d4d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,8 +7,8 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "TeachOS Kernel" -copyright = "2023, Felix Morgner" -author = "Felix Morgner" +copyright = "2023, The TeachOS Developers" +author = "The TeachOS Developers" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/docs/design.rst b/docs/design.rst new file mode 100644 index 00000000..33dbc7e1 --- /dev/null +++ b/docs/design.rst @@ -0,0 +1,2 @@ +Design Overview +=============== \ No newline at end of file diff --git a/docs/guides.rst b/docs/guides.rst new file mode 100644 index 00000000..0f5cca62 --- /dev/null +++ b/docs/guides.rst @@ -0,0 +1,9 @@ +Guides and How-Tos +================== + +.. toctree:: + :maxdepth: 1 + :caption: Contents + :glob: + + guides/* diff --git a/docs/guides/device-drivers.rst b/docs/guides/device-drivers.rst new file mode 100644 index 00000000..61a91ddf --- /dev/null +++ b/docs/guides/device-drivers.rst @@ -0,0 +1,2 @@ +Implementing a Device Driver +============================ \ No newline at end of file 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