Skip to content

[AAASM-4743] 📝 (examples): Fix stale docs (workflows table, rename links, version comment, gateway-image status)#320

Merged
Chisanan232 merged 4 commits into
masterfrom
v0.0.1/AAASM-4743/doc_drift_fixes
Jul 17, 2026
Merged

[AAASM-4743] 📝 (examples): Fix stale docs (workflows table, rename links, version comment, gateway-image status)#320
Chisanan232 merged 4 commits into
masterfrom
v0.0.1/AAASM-4743/doc_drift_fixes

Conversation

@Chisanan232

Copy link
Copy Markdown
Contributor

What changed

Four LOW-severity doc-drift items found against AAASM-4743, each an atomic commit:

  1. .github/workflows/README.md — the "Planned workflows / coming soon" table
    listed only verify-python.yml / verify-node.yml / verify-go.yml /
    verify-scenarios.yml as unimplemented. All four already exist and run,
    plus six more (verify-all-samples.yml, verify-live.yml,
    example-metadata-check.yml, codeql.yml, proof-html.yml,
    auto-assign.yml). Rewrote the table to list the full, actually-implemented
    workflow set and dropped the "coming soon" framing.
  2. python/{agno,autogen,semantic-kernel,strands-agents}-tool-policy/README.md
    each linked the pre-rename repo github.com/AI-agent-assembly/agent-assembly-examples
    (dropped org-wide in the 2026-07-09 rename, AAASM-4341 — old URLs
    301-redirect, but the doc text was stale). Repointed to
    github.com/ai-agent-assembly/examples, matching the sibling
    haystack-tool-policy / llamaindex-tool-policy READMEs, which already
    used the correct URL.
  3. python/microsoft-agent-framework-tool-policy/pyproject.toml — the
    rationale comment above the agent-assembly pin said "0.0.1rc5 remains the
    latest installable version," but the pin itself was already ==0.0.1rc6
    (the version literal is generator-owned and had been correctly bumped; only
    the comment had gone stale). Rather than just re-hardcoding "rc6," followed
    python/openai-agents-sdk/pyproject.toml's existing pattern of citing the
    AAASM-4441 exception notes instead of a specific version, so the comment
    can't drift again on the next SDK bump.
  4. scenarios/live-core-enforcement/README.md — the "Heads-up" callout, the
    Prerequisites row, and the "Gateway image dependency" section all asserted
    ghcr.io/ai-agent-assembly/aa-gateway is not published. It now is —
    confirmed live via the GHCR anonymous-token tags/list API, which returned
    v0.0.1-rc.4, v0.0.1-rc.5, v0.0.1-rc.6, and latest. Updated all three
    spots to describe the gateway as a separate-but-published image rather than
    an unpublished blocker.

Not changed, flagged for awareness: verify-scenarios.yml's
live-core-enforcement-live job is still gated if: github.event_name == 'workflow_dispatch' with a comment saying to trigger it manually "when a
gateway image is available." That comment is now stale too (the image is
published), but reworking the CI trigger/gate is a behavior change outside
this ticket's doc-drift scope — flagging it here rather than changing CI
behavior unilaterally. A follow-up ticket could promote that job to run
automatically now that the image dependency is satisfied.

Related ticket

https://lightning-dust-mite.atlassian.net/browse/AAASM-4743

Fixes AAASM-4743

How to verify

  • .github/workflows/ — diff the table in README.md against
    ls .github/workflows/*.yml; all ten files are now listed.
  • Repo links — grep -rn "AI-agent-assembly/agent-assembly-examples" python/
    now returns nothing; the four READMEs match the
    github.com/ai-agent-assembly/examples URL already used by
    haystack-tool-policy / llamaindex-tool-policy.
  • python scripts/generate_example_metadata.py --check passes with no drift
    (run after all four commits — the pyproject.toml comment change doesn't
    touch the generator-owned version literal).
  • Gateway image publication verified independently via:
    token=$(curl -s "https://ghcr.io/token?scope=repository:ai-agent-assembly/aa-gateway:pull" | jq -r .token)
    curl -s -H "Authorization: Bearer $token" "https://ghcr.io/v2/ai-agent-assembly/aa-gateway/tags/list"
    # => {"name":"ai-agent-assembly/aa-gateway","tags":["v0.0.1-rc.4","latest","v0.0.1-rc.5","v0.0.1-rc.6"]}
    
  • Did not run the scenario's full Docker E2E (no Docker daemon in this
    environment) — this PR only corrects the published/unpublished factual
    claim in the docs, not the runtime behavior.

Checklist

  • PR title follows [AAASM-XXXX] <GitEmoji> (<scope>): <summary>
  • No secrets, API keys, or .env files committed
  • Example sub-projects include their own README.md with prerequisites and run instructions
  • SDK/runtime version dependencies are documented or pinned

All four verify-*.yml workflows already exist and run, plus six more
(verify-all-samples, verify-live, example-metadata-check, codeql,
proof-html, auto-assign) that the README never documented.
agno/autogen/semantic-kernel/strands-agents-tool-policy READMEs still
linked github.com/AI-agent-assembly/agent-assembly-examples (dropped in
the 2026-07-09 org repo rename, AAASM-4341). Point at
github.com/ai-agent-assembly/examples, matching the sibling
haystack-tool-policy / llamaindex-tool-policy READMEs.
The pin below the comment was already bumped to 0.0.1rc6 (the generator
manages the version literal), but the rationale comment still claimed
rc5 was the latest installable version. Follow openai-agents-sdk's
pattern of citing AAASM-4441's exception notes instead of a hardcoded
version so the comment can't go stale on the next SDK bump.
ghcr.io/ai-agent-assembly/aa-gateway is now published (confirmed tags
v0.0.1-rc.4/rc.5/rc.6/latest via the GHCR anonymous tags/list API) —
update the "Heads-up" callout, Prerequisites row, and Gateway image
dependency section that all asserted it was unpublished.

Not changed: verify-scenarios.yml still gates the real end-to-end
live-core-enforcement-live job behind workflow_dispatch only, per its
own comment ("Trigger it deliberately ... when a gateway image is
available"). That CI gate is now stale too, but reworking it is out of
scope here — noted in the PR description instead.
@sonarqubecloud

Copy link
Copy Markdown

@Chisanan232

Copy link
Copy Markdown
Contributor Author

Claude Code — automated review

CI: All green — full example + scenario matrix (all framework samples, metadata-drift, offline scenarios) pass.

Scope vs AAASM-4743: Complete. Coming-soon workflow table replaced with the real set; 4 stale pre-rename repo links fixed; rc5 orphan comment re-pointed to the exception ticket; live-core-enforcement README corrected (gateway image IS published, verified via GHCR). Generator --check passes.

Side effects: None — documentation-only; a stale CI-trigger comment in verify-scenarios.yml was flagged for a separate follow-up, not changed here.

Verdict: ✅ Ready for approval & merge.

@Chisanan232
Chisanan232 merged commit c80d832 into master Jul 17, 2026
41 checks passed
@Chisanan232
Chisanan232 deleted the v0.0.1/AAASM-4743/doc_drift_fixes branch July 17, 2026 03:41
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