Skip to content

Commit f61ebb1

Browse files
authored
test(docs): guard effect interpreter canonical docs (#2922)
1 parent 6cf1dec commit f61ebb1

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

examples/docs-governance-smoke.py

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,35 @@ def assert_local_doc_links_resolve() -> None:
120120
)
121121

122122

123+
def assert_effect_interpreter_docs_are_canonical() -> None:
124+
packet_doc = compact(read("docs/reference/effect-interpreter-packet.md"))
125+
for required in (
126+
"EffectRequest",
127+
"EffectInterpretation",
128+
"EffectObservation",
129+
"EffectNext",
130+
"EffectTurn",
131+
"Around Semantics",
132+
):
133+
assert required in packet_doc, required
134+
135+
rfc = compact(read("docs/architecture/rfcs/agent-loop-effect-interpreter-v0.md"))
136+
for required in (
137+
"Composition And Around Semantics",
138+
"Handler Is Data, Not a Callable",
139+
"Milestone Status",
140+
):
141+
assert required in rfc, required
142+
143+
architecture = compact(read("docs/architecture.md"))
144+
assert "Control Plane As Effect Interpreter" in architecture
145+
146+
lecture = compact(
147+
read("docs/development/control-plane-course/01-agent-loop-effectful-program.md")
148+
)
149+
assert "Around 是数据,不是回调" in lecture
150+
151+
123152
def main() -> int:
124153
docs_index = read("docs/README.md")
125154
root_readme = read("README.md")
@@ -287,6 +316,7 @@ def main() -> int:
287316
)
288317

289318
assert_local_doc_links_resolve()
319+
assert_effect_interpreter_docs_are_canonical()
290320

291321
collaboration_rfc = read(
292322
"docs/architecture/rfcs/agent-im-openviking-collaboration-v0.md"

0 commit comments

Comments
 (0)