commit 363642d050c5a0e90790eb0c839beef907730d4e Author: decentral1se Date: Mon Sep 29 11:18:52 2025 +0200 feat: init diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c6732a --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# almanac + +## Issues + +* The recipe catalogue is big and getting bigger. Cloning it locally when + running the first commands with `abra` is now becoming *super* slow. Parsing + versions and doing on-the-fly catalogue operations in `abra` is getting + slower, and slower. +* It would be better if `abra` didn't even have catalogue management + functionality and simply was a "catalogue client" and not also producer. This + reduces the scope of `abra` further which has benefits. +* We need less manual work and more automation to support us so that our + project remains sustainable as it scales out horizontally (more collectives, + more recipes, more activity). It would be simpler to have automation which + doesn't rely on a [relatively complex CI/CD + setup](https://git.coopcloud.tech/toolshed/organising/issues/604#issuecomment-20279). + +## Prototype + +* Single binary GUI-less web API instead of a monolithic Git repository ([`#604`](https://git.coopcloud.tech/toolshed/organising/issues/604)). +* Minimal configuration: point it at a Gitea organsation and you're done. +* Webhook API for on-demand catalogue generation. +* Background scheduler for periodic catalogue generation. +* Optimized recipe API for `abra` queries (auto-completion, recipe versions, etc.). +* Re-use the `abra catalogue sync` command to maintain `--offline` support.