From f3babde415964d6d3dd30a13a5193ad0783333d0 Mon Sep 17 00:00:00 2001 From: Viktor Lofgren Date: Tue, 7 Mar 2023 17:32:16 +0100 Subject: [PATCH] Readme for code/ --- code/readme.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 code/readme.md diff --git a/code/readme.md b/code/readme.md new file mode 100644 index 00000000..34a7c8c1 --- /dev/null +++ b/code/readme.md @@ -0,0 +1,27 @@ +# Code + +This is a pretty large and diverse project with many moving parts. +You'll find a short description in each module of what it does and how it relates to other modules. + +## Overview + +### Services +* [core services](services-core/) "macroservices", stateful, memory hungry doing heavy lifting. +* * [search](services-core/search-service) +* * [index](services-core/index-service) +* * [assistant](services-core/assistant-service) +* [sattelite services](services-satellite/) "microservices", stateless providing additional functionality. +* * [api](services-satellite/api-service) - public API +* * [dating](services-satellite/dating-service) - [https://explore.marginalia.nu/](https://explore.marginalia.nu/) +* * [explorer](services-satellite/explorer-service) - [https://explore2.marginalia.nu/](https://explore2.marginalia.nu/) +* an [internal API](api/) + +### Libraries and primitives +* [common](common/) elements for creating a service, a client etc. +* [index primitives](index/) +* [crawling and analysis](crawl/) +* [libraries](libraries/) containing non-search specific code. +* * [array](libraries/array/) - large memory mapped area library +* * [btree](libraries/btree/) - static btree library +* + more +* [features](features/) containing code that is specific to search but shared among services. \ No newline at end of file