Skip to content

Docs/tests: orchestrator specs and test cleanup #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dhirmadi merged 1 commit into from
Jan 2, 2026
Merged

Docs/tests: orchestrator specs and test cleanup #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions docs_v2/01_Overview/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,33 @@
# Social Media Publisher — V2 Documentation Set

Version: 2.3
Last Updated: December 21, 2025
Status: Approved for implementation
Last Updated: December 30, 2025
Status: Canonical docs (live; maintained)

This folder contains the complete documentation to implement a brand‑new, modernized solution that preserves Dropbox for storage while upgrading AI, architecture, and publishing flows.
**Canonical entrypoint:** `docs_v2/README.md`

This folder provides a reading-oriented overview of the V2 documentation set.

Contents:
- `03_Architecture/SYSTEM_DESIGN.md` — System overview, goals, scope, user journeys
- `03_Architecture/ARCHITECTURE.md` — Architecture, components, interfaces, deployment
- `02_Specifications/USER_FLOW.md` — End‑to‑end flows, sequence diagrams, UX behaviors
- `02_Specifications/SPECIFICATION.md` — Complete implementation spec (APIs, contracts, data models)
- `02_Specifications/ORCHESTRATOR_SERVICE_API_INTEGRATION_GUIDE.md` — Orchestrator service-to-service API integration (when using platform orchestrator)
- `02_Specifications/ORCHESTRATOR_RUNTIME_CONFIG_SCHEMA_REFERENCE.md` — Canonical orchestrator runtime config schema + GUI validation rules
- `07_AI/AI_PROMPTS_AND_MODELS.md` — Model choices, prompting strategies, evaluation
- `05_Configuration/CONFIGURATION.md` — Environment, INI schema, pydantic validation
- `05_Configuration/CONFIGURATION.md` — Configuration model (orchestrator-default), env/INI compatibility, validation
- `08_Epics/000_v2_foundation/000_preview_mode/000_feature.md` — Preview mode guarantees (no side effects)
- `04_Security_Privacy/SECURITY_PRIVACY.md` — Security posture, secrets, sessions, PII, logging
- `06_NFRs/NFRS.md` — Non‑functional requirements and targets

Start with SYSTEM_DESIGN.md, then read SPECIFICATION.md and ARCHITECTURE.md. AI coders can safely implement using SPECIFICATION.md alone, with ARCHITECTURE.md and CONFIGURATION.md as reference.
Suggested reading order:

1. `docs_v2/README.md` (navigation)
2. `03_Architecture/SYSTEM_DESIGN.md`
3. `03_Architecture/ARCHITECTURE.md`
4. `05_Configuration/CONFIGURATION.md` (orchestrator-default)
5. `02_Specifications/SPECIFICATION.md` (implementation details)

Notable capabilities:
- Stable‑Diffusion‑ready caption sidecar (`<image>.txt`) generated alongside normal captions
Expand Down
Loading
Loading