docs: consolidate design + decisions into docs/DESIGN.md, slim READMEs#11
Merged
Merged
Conversation
Single canonical document for new contributors and operators. Cleans up stale documentation and replaces it with a coherent architecture + decision-log narrative. What landed: * **`docs/DESIGN.md`** (new, ~600 lines) — the consolidated design document. Sixteen sections covering: what the framework is, the layered architecture (LangGraph + LangChain + FastMCP + framework + app), core abstractions (Session, Skill, AgentRun, ToolCall, Orchestrator, Gateway, AgentTurnOutput), runtime model (lifecycle, dispatch, routing, termination), LLM provider story (per-agent override, 429 retry, live verification), markdown turn-output contract (the 7 parse paths + gpt-oss quirks), HITL approve/reject (langgraph 1.x __interrupt__ semantics + the five PR #6 fixes), storage, telemetry, deployment, decision log (12 numbered DEC-NNN entries with rationale), milestone history (v1.0–v1.5), pending list, and a "where to find what" map. * **`README.md`** (new, repo root) — short overview pointing at docs/DESIGN.md as the canonical entry. Quickstart commands, two example apps named, document map. * **`examples/incident_management/README.md`** — slimmed from ~230 lines to ~80. Removed framework-wide content (Phase 4/5/6/8/9 narrative, agent kinds explainer, trigger registry walkthrough, genericity ratchet description) — all of that lives in docs/DESIGN.md now. App README focuses on the layout, domain shape, MCP tools, ASR memory layers. * **`examples/code_review/README.md`** — slimmed from ~120 lines to ~70. Same treatment: framework explainer text moved to DESIGN, README focuses on app-specific details. * **`.gitignore`** — explicitly track `docs/DESIGN.md` next to the other two committed docs (`AIRGAP_INSTALL.md`, `DEVELOPMENT.md`). The `docs/*` blanket ignore stays so accidentally-generated scratch doesn't leak in. * Deleted four committed `.planning/phases/*` artifacts (Phase 01 summary, Phase 14 plan / summary / verification). Their content is superseded by docs/DESIGN.md § 13 (milestone history) and § 12 (decision log). The `.planning/` directory is gitignored per-convention; these were committed before that convention applied. `docs/DEVELOPMENT.md` and `docs/AIRGAP_INSTALL.md` are unchanged — they're operational how-tos (regenerate dist, install behind a mirror) rather than design content, and remain accurate. Suite: 1265 passed (unchanged), ruff clean. No source changes.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Single canonical document for new contributors and operators. Cleans up stale documentation across the repo.
What landed
docs/DESIGN.md(new, ~600 lines)The consolidated design document. Sixteen sections:
Session,Skill,AgentRun,ToolCall,Orchestrator,Gateway,AgentTurnOutput)__interrupt__semantics + the five PR fix(hitl): HITL approve/reject end-to-end + gpt-oss markdown reliability #6 fixesREADME.md(new, repo root)Repo had no top-level README. One-screen overview pointing at the three docs (
DESIGN.md,DEVELOPMENT.md,AIRGAP_INSTALL.md). Quickstart commands. Status block.Slimmed example READMEs
examples/incident_management/README.md: ~230 → ~80 lines. Removed framework-wide content (Phase 4/5/6/8/9 narrative, agent kinds, trigger registry, ratchet) — all in DESIGN now. App-specific layout / domain shape / MCP tools / ASR memory layers stay.examples/code_review/README.md: ~120 → ~70 lines. Same treatment.Deleted stale committed artifacts
.planning/phases/01-concurrency-foundation/01-01-SUMMARY.md.planning/phases/14-reproducible-air-gap-lockfile/14-01-PLAN.md,14-01-SUMMARY.md,14-VERIFICATION.mdTheir content is superseded by DESIGN § 13 (milestone history) + § 12 (decision log). The
.planning/directory is gitignored per-convention; these were committed before that convention applied..gitignoreExplicitly track
docs/DESIGN.mdnext to the other two committed docs.Unchanged
docs/DEVELOPMENT.mdanddocs/AIRGAP_INSTALL.mdare operational how-tos (regenerate dist, install behind a mirror) rather than design content, and remain accurate.Test plan
uv run ruff check src/ tests/— cleanuv run pytest -x— 1265 passed, 8 skipped (unchanged — docs-only)🤖 Generated with Claude Code