CatgirlIntelligenceAgency/doc/readme.md

22 lines
730 B
Markdown
Raw Normal View History

2023-03-25 15:46:19 +01:00
# Documentation
A lot of the architectural description is sprinkled into the code repository closer to the code.
2023-03-25 15:47:45 +01:00
Start in [📁 ../code/](../code/) and poke around.
2023-03-25 15:46:19 +01:00
Operational documentation is available at [🌎 https://docs.marginalia.nu/](https://docs.marginalia.nu/).
2023-03-27 17:25:27 +02:00
## Operations
2023-09-24 19:40:45 +02:00
## How-To
* [Parquet How-To](parquet-howto.md) - Useful tips in working with Parquet files
2023-03-27 17:25:27 +02:00
2023-03-25 15:46:19 +01:00
## Set-up
2023-03-25 15:47:45 +01:00
* [📁 ../run/](../run/) - Set-up instructions
2024-01-24 14:39:33 +01:00
* [📄 ide-configuration.md](ide-configuration.md) - How to set up an IDE for development
2023-03-25 15:46:19 +01:00
## Documents
* [Module Taxonomy](module-taxonomy.md) - What is a 'service' and what is a 'library'.
* [Useful Resources](useful-resources.md) - Links to resources on IR and search engines.