docs: link thesis system design draft
This commit is contained in:
@@ -1081,6 +1081,8 @@ uv run wf --config examples/report_workflow/wf.config.json run trace <run_id> --
|
|||||||
|
|
||||||
## Appendix B: Evidence Index
|
## Appendix B: Evidence Index
|
||||||
|
|
||||||
|
See `evidence-index.md` for the full claim-to-evidence map.
|
||||||
|
|
||||||
| Claim | Evidence |
|
| Claim | Evidence |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| Workflow lifecycle models | `src/wf_artifacts/models.py`, `src/wf_artifacts/runs/` |
|
| Workflow lifecycle models | `src/wf_artifacts/models.py`, `src/wf_artifacts/runs/` |
|
||||||
|
|||||||
@@ -183,6 +183,9 @@ stable.
|
|||||||
- Completed thesis case-study evidence bundle: `examples/report_workflow/`
|
- Completed thesis case-study evidence bundle: `examples/report_workflow/`
|
||||||
provides a deterministic report workflow with Python source, fixture input,
|
provides a deterministic report workflow with Python source, fixture input,
|
||||||
config, runbook, and tests.
|
config, runbook, and tests.
|
||||||
|
- Completed thesis system-design draft: `docs/add/system-design-implementation.md`
|
||||||
|
now frames the platform as a formal system design/implementation report backed
|
||||||
|
by `docs/add/evidence-index.md` and the report-workflow case study.
|
||||||
|
|
||||||
## Historical References
|
## Historical References
|
||||||
|
|
||||||
|
|||||||
@@ -70,6 +70,11 @@ see [`workflow platform presentation`](add/2026-06-workflow-platform-presentatio
|
|||||||
lifecycle from the RPC CLI smoke runbook, and cleans up. Use
|
lifecycle from the RPC CLI smoke runbook, and cleans up. Use
|
||||||
`--keep-temp` to preserve the generated config/store on failure.
|
`--keep-temp` to preserve the generated config/store on failure.
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- `docs/add/system-design-implementation.md` — formal thesis/system-design draft.
|
||||||
|
- `docs/add/evidence-index.md` — claim-to-evidence map for the thesis draft.
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
|
|
||||||
- `tests/authoring`: builder, node decorator, ops, async runtime, subgraph, and
|
- `tests/authoring`: builder, node decorator, ops, async runtime, subgraph, and
|
||||||
|
|||||||
@@ -0,0 +1,32 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
ROOT = Path(__file__).resolve().parents[2]
|
||||||
|
|
||||||
|
|
||||||
|
def test_big_doc_links_case_study_and_evidence_index() -> None:
|
||||||
|
doc = (ROOT / "docs" / "add" / "system-design-implementation.md").read_text(
|
||||||
|
encoding="utf-8"
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "examples/report_workflow" in doc
|
||||||
|
assert "docs/add/evidence-index.md" in doc or "evidence-index.md" in doc
|
||||||
|
|
||||||
|
|
||||||
|
def test_project_map_links_big_doc() -> None:
|
||||||
|
project_map = (ROOT / "docs" / "project_map.md").read_text(encoding="utf-8")
|
||||||
|
|
||||||
|
assert "system-design-implementation.md" in project_map
|
||||||
|
assert "evidence-index.md" in project_map
|
||||||
|
|
||||||
|
|
||||||
|
def test_big_doc_keeps_mcp_as_source_family() -> None:
|
||||||
|
doc = (ROOT / "docs" / "add" / "system-design-implementation.md").read_text(
|
||||||
|
encoding="utf-8"
|
||||||
|
)
|
||||||
|
|
||||||
|
assert "MCP" in doc
|
||||||
|
assert "source family" in doc
|
||||||
|
assert "product identity" in doc
|
||||||
Reference in New Issue
Block a user