asepharyana
3882c5aef0
- Introduced AGENT-SPECS.md detailing the specifications for seven agents including their inputs, processing steps, and outputs. - Created API-REFERENCE.md outlining the Sectors API v2 endpoints, parameters, costs, and usage. - Developed API.md to specify backend routes, request/response structures, and error handling. - Established ARCHITECTURE.md to describe the project layout, conventions, scheduler, and citation pipeline. - Added DATA-MODEL.md to define the database schema, tables, and seed strategy. - Compiled PLAN.md to outline the project concept, problem statement, unique features, and implementation timeline. - Created README.md as an index for documentation with links to all relevant files. - Documented ROUTINES.md detailing the seven automated routines, their schedules, inputs, detection logic, and delivery formats. - Introduced TECH-STACK.md to specify the technology choices and rationale for both backend and frontend components.
1.0 KiB
1.0 KiB
docs index
Spec-driven source of truth. Code follows these docs; docs change before code.
| Doc | Contents |
|---|---|
| PLAN.md | Concept: Autopilot Routines, Verifiable AI, Accuracy Ledger; agents, features, architecture, data model, routes, pages, rules, timeline, verification, risks |
| API-REFERENCE.md | All 70 Sectors v2 paths with params, costs, FlowSight usage, per-cycle credit budget |
| TECH-STACK.md | Pinned versions, deps, why-chosen, declined alternatives, CI gates |
| ARCHITECTURE.md | Backend/frontend layout, scheduler, agent contracts, citation pipeline, SSE design |
| ROUTINES.md | 7 routine specs: schedule, inputs, detection logic, delivery format |
| AGENT-SPECS.md | 7 agent contracts: inputs, processing steps, outputs, verification fixtures |
| DATA-MODEL.md | Table schemas, indexes, retention, seed strategy |
| API.md | Backend route specs: request/response shapes, errors, auth |