Skip to content

docs: fix two stale claims in LIMITATIONS.md - #36

Merged
imran-siddique merged 1 commit into
agentrust-io:mainfrom
rajnisht7:fix-stale-doc
Aug 31, 2026
Merged

docs: fix two stale claims in LIMITATIONS.md#36
imran-siddique merged 1 commit into
agentrust-io:mainfrom
rajnisht7:fix-stale-doc

Conversation

@rajnisht7

Copy link
Copy Markdown
Contributor

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

  • No wire-contract change
  • Backward-compatible contract change with fixtures
  • Breaking contract change with migration notes

Evidence

  • python tools/sync_schemas.py
  • python tools/check_schemas.py
  • python conformance/runner/validate.py
  • python -m unittest discover -s tests -v
  • python -m build

Privacy and security

  • No real prompts, source, credentials, personal data, or production identifiers added
  • New fields have capture semantics and privacy classification
  • Security-sensitive changes received maintainer review

Limits

State what this change does not prove or cover.

@imran-siddique imran-siddique left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@imran-siddique
imran-siddique merged commit 9038daf into agentrust-io:main Aug 31, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants