From a0837c15fe1a070ae517b2958d0bb9aa6e98e6c9 Mon Sep 17 00:00:00 2001 From: jmd Date: Thu, 10 Oct 2024 19:42:21 -0700 Subject: [PATCH] [docs] stub out kernel doc --- docs/structure/kernel.rst | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/docs/structure/kernel.rst b/docs/structure/kernel.rst index 4cb9cbf48..d3407cf26 100644 --- a/docs/structure/kernel.rst +++ b/docs/structure/kernel.rst @@ -4,16 +4,43 @@ kernel The ``kernel`` module provides submodules for handling global resources and services. It's designed around some explicit goals: +- Any function or object that can modify global state must be contained + in this module for easy search/grepability. ``using nwk = nw::kernel`` is an acceptable abreviation. - Every service should be easily overrideable to allow for `parallel implementation `__. - Every service should be decoupled from the kernel itself. -- Any function or object that can modify global state must be contained - in this module for easy search/grepability. + +Config +~~~~~~ + +:cpp:struct:`nw::kernel::Config` Services -------- -Config -~~~~~~ +EffectSystem +------------ + +EventSystem +----------- + +FactionSystem +------------- + +ModelCache +---------- + +ObjectSystem +------------ + +Rules +----- + +Strings +------- + +TilesetRegistry +--------------- -The ``Config`` service provides access to installation info. +TwoDACache +----------