docs: fix two stale claims in LIMITATIONS.md - #36
Conversation
imran-siddique
left a comment
There was a problem hiding this comment.
Merging. This is a documentation class I care about more than most: LIMITATIONS.md said "Only a Python reference SDK exists" and "No metrics projector or AGT adapter is implemented", both of which were true when written and false once the TypeScript SDK, OTelMetricEmitter and the four AGT adapter modules landed.
A stale limitations file is worse than an absent one. It is the document a careful reader consults precisely to find out what they cannot rely on, so understating our own capability there costs us the readers who were being most careful.
Replacing the two dead lines with the actual current gap, that no adapter yet emits approval.cancelled, approval.execution_* or evidence.* lifecycle events although the schema already defines them, is the right substitution. A limitations file whose entries are all obsolete teaches people to stop reading it; one that names a real present gap keeps it worth opening.
Summary
LIMITATIONS.md said "Only a Python reference SDK exists" and "No metrics projector or AGT adapter is implemented." Both are false today a full TypeScript SDK (packages/typescript/), OTelMetricEmitter, and four AGT adapter modules already ship and are tested. Both lines were true when written but never updated after the features landed in later PRs. Replaced with the actual current gap: no adapter yet emits approval.cancelled, approval.execution_, or evidence. lifecycle events, even though those event types are already defined in the schema.
Contract impact
Evidence
python tools/sync_schemas.pypython tools/check_schemas.pypython conformance/runner/validate.pypython -m unittest discover -s tests -vpython -m buildPrivacy and security
Limits
State what this change does not prove or cover.