Skip to content

docs: correct A2A signing docs and supported versions; drop em-dashes - #152

Merged
vvillait88 merged 1 commit into
mainfrom
docs-audit-fixes
Oct 3, 2026
Merged

vvillait88 merged 1 commit into
mainfrom
docs-audit-fixes

Conversation

@vvillait88

Copy link
Copy Markdown
Contributor

Summary

Doc corrections from an audit of every repo's docs against code, plus an em-dash sweep.

  • SECURITY.md listed 2.x as the supported line; the package is on 3.x.
  • README A2A example called the card a "Signed Agent Card" whose identity claims live in a separate JWS wrapping it. build_a2a_agent_card returns the card unsigned, and an A2A 1.0 card carries its JWS entries in its own signatures field. The comment now says that.
  • A2A module docstring said to "wrap" the card in a signature and called the spec "Google A2A"; it now says to attach the JWS entries as signatures.
  • "the 2.0 high-level surface" removed from the README and CLAUDE.md (version-introduction text, and the package is on 3.x).
  • CLAUDE.md /api row now lists the four names agentscore_commerce.api re-exports, not one.
  • examples/README.md: the compute-first example uses compute_first_checkout, which is backed by create_quote_cache; it does not import the cache itself.
  • A broken # , comment in the README UCP example is fixed.
  • Em-dashes removed everywhere except the one test that asserts skill.md output contains none. A spaced em-dash became a colon; dashes used as a pair became parentheses. This touches agent-facing strings (denial instructions, skill.md text), which ship in the next release; no release is cut for this alone.

Type of change

  • Bug fix (no breaking change)
  • New feature (no breaking change)
  • Breaking change (existing callers must update)
  • Docs, tests, or internal maintenance only

Public API

None. No exported name, signature or value changed. String content in agent-facing text changed punctuation only.

Test plan

ruff check, ruff format --check, ty check and pytest (1892 passed, 4 skipped) all exit 0. Repo-wide em-dash count afterwards: 1, the assertion in tests/test_skill_md.py. The sweep kept # noqa codes parseable and the Sphinx #: attribute comments intact.

Checklist

  • Tests cover the new behavior, and the suite passes locally (no behavior changed; suite passes)
  • Lint, format, and type checks pass
  • Docs and README examples updated if the public surface changed
  • No secrets, credentials, or personal data in the diff or the tests

@vvillait88
vvillait88 merged commit a1c65ef into main Oct 3, 2026
12 checks passed
@vvillait88
vvillait88 deleted the docs-audit-fixes branch October 3, 2026 22:48
@vvillait88 vvillait88 mentioned this pull request Oct 4, 2026
5 of 8 tasks
vvillait88 added a commit that referenced this pull request Oct 4, 2026
## Summary

Releases 3.1.0, carrying everything merged since 3.0.0:

- the quota denial message no longer tells an agent to retry, at all six
adapters (#153)
- `to_security_requirements` exported from `identity` and the package
root (#151), which is the new public surface that makes this a minor
- A2A signing docs and supported versions corrected, README notes on UCP
`keys[]` (#150, #152)
- fastapi 0.142 resolves under the `if-necessary` prerelease rule with
the `web3<8` constraint (#149)

Also in this PR: `agentscore-py` floor raised to 2.7.1 (released today),
and the `web3<8` comment now states the real blocker. web3 8.0.0 is
stable, but it needs eth-abi 6, which pympp's `tempo` extra excludes
(`eth-abi<6`, pympp 0.11.0 is the latest), so an unconstrained re-lock
lands on the 8.0.0b3 beta and pinning 8.0.0 downgrades pympp to 0.9.1. I
tried the lift: the beta resolution passed the suite, but shipping a
beta to merchants is the thing the constraint exists to prevent.

Worked with: Varun.

Out of scope: lifting `web3<8`, which waits on pympp admitting eth-abi
6.

## Type of change

- [ ] Bug fix (no breaking change)
- [x] New feature (no breaking change)
- [ ] Breaking change (existing callers must update)
- [ ] Docs, tests, or internal maintenance only

## Public API

`to_security_requirements` is newly exported (merged in #151). Nothing
removed or changed.

## Test plan

`ruff check`, `ruff format --check`, `ty check` and `pytest` (1893
passed, 4 skipped, 95.41% coverage) pass locally on this branch.

## Checklist

- [x] Tests cover the new behavior, and the suite passes locally
- [x] Lint, format, and type checks pass
- [x] Docs and README examples updated if the public surface changed
- [x] No secrets, credentials, or personal data in the diff or the tests
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.

1 participant