added ascii tree to reqs

This commit is contained in:
Ty
2026-07-08 21:44:34 +00:00
parent 3ed95be797
commit f64240d6dc
+41 -26
View File
@@ -82,32 +82,47 @@ Alice-30. Understand the reasoning and supporting evidence behind key research f
Requirements defined as what the product / system must do, differentiated from what the persona can accomplish. Requirements are defined to meet the needs of use cases as well as the architectural system design.
High level design (refer to ***TBD_Design.MD for full design details)
Linux
>> Docker
> > SQLLite
> > CRON
> > Runtime
> > HTTP client (internet accessible)
> > Supports OpenAI inference endpoint
> > Supports HTTP queries for data feeds (RSS, Curl, Playwright?)
> > HTTP server endpoint (internet acceesible)
> > MCP
> > HTTP client (intranet)
> > Supports OpenAI inference endpoint to Hermes
> > File system
> > Output dir for daily digest artifact (saved outside of the docker container)
> > Diagnostics / instrumentation (should land in the Docker infa for this container)
> > Configuration
> > Research topic mainfest (feeds, URLS, declarations)
> > System settings (YAML)
> > System secrets (.env))
> > Business logic
> > Starting trigger
> > preflight check
> > Query feeds / TMP store results
> > Vet temp results / store final results to DB
> > Produce digest (if configured)
> > Cleanup / sleep
High-Level Design
.
├── Runtime Environment
│ ├── Linux
│ └── Docker (containerized)
├── Core Components
│ ├── Database: SQLite
│ ├── Scheduling: Cron
│ └── Runtime: Python
├── Connectivity
│ ├── Outbound (Internet)
│ ├── HTTP client for data feeds (RSS, cURL, optional Playwright)
│ │ └── OpenAI-compatible inference endpoints
│ ├── Inbound (Internet)
└── HTTP server endpoint (MCP + external consumers)
│ └── Internal (Intranet)
└── HTTP client for local inference (e.g. Hermes)
├── Storage
│ ├── File system (daily digest artifacts stored outside container)
│ └── Temporary working storage during pipeline execution
├── Configuration & Secrets
│ ├── Research topic manifest (feeds, URLs, declarations)
│ ├── System settings (YAML)
│ └── Secrets (.env)
├── Business Logic / Pipeline Flow
│ ├── Starting trigger
│ ├── Preflight checks
│ ├── Query feeds → Temporary result storage
│ ├── Vet and promote final results to database
│ ├── Optional daily digest generation
│ └── Cleanup and sleep
└── Observability
├── Structured logging
├── Diagnostics and instrumentation (inside Docker)
└── Health/status reporting
3.1 Setup and configuration (REQ-SNC-XX)
Requirements for initial setup, deployment configs, updating, and uninstall