Skip to content

Latest commit

 

History

History
11 lines (5 loc) · 932 Bytes

File metadata and controls

11 lines (5 loc) · 932 Bytes

-* [ ] Quick Start in README — One copy-paste command with expected output, plus a “hello research” example brief and result.

  • Environment & secrets handling — Support a .env file and a committed .env.example documenting required variables (LLM_BASE_URL, LLM_MODEL, SEARXNG_URL, CACHE_DIR, LANGUAGE, SOURCE_CAPS). Ensure secrets are not baked into images; pass keys only via env or mounted files.

  • Resource limits — Set conservative cpu/memory limits and reservations per service; document how to override (e.g., COMPOSE_PROFILES=dev LLM_MEMORY_GB=8). Ensure the tool fails gracefully when limits are hit.

  • References enrichment — resolve/insert DOIs where available, add stable URLs and “Accessed on” dates for web sources; completeness validator.

-* [ ] Proofreading pass — grammar/spell/consistency check (units, terminology, capitalization) before final render.