Repository navigation
docs: state what saga a2ui does and track open gaps in Backstage - #400
Merged
Merged
Conversation
Public guides, READMEs, the docs site and the tour now describe what works and how to use it. Lists of unverified behavior, inconclusive or failed probes and "does not establish" hedges are removed; those gaps are tracked as Backstage issues. - CONTRIBUTING.md gains "State what works", the standing rule; AGENTS.md and change-hygiene.md point to it. - host-compatibility.md is rewritten around supported flows per host. - The Stable 0.7.6 site drops the dated host-observations page; the 0.11.0-rc.1 host page is a reviewed correction, recorded with a new `corrected` field that verify-source and the reproduction test honor. - Generated component pages render a "Qualification" section only when a release lists one, without the boilerplate hedge. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…tion pattern Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…mmit-pinned Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…-clarity-39622d # Conflicts: # docs/development-reference.md
…nto claude/saga-a2ui-docs-clarity-39622d # Conflicts: # docs/development-reference.md
…-clarity-39622d # Conflicts: # docs/authorized-playback.md # docs/build-tic-tac-toe-with-react.md # docs/faithful-card-styling.md
…-clarity-39622d # Conflicts: # docs.json # docs/releases/0.7.6/release.json # docs/releases/1.0.0/components/action-button.mdx # docs/releases/1.0.0/components/catalog.json # docs/releases/1.0.0/components/faithful-card.mdx
…-clarity-39622d # Conflicts: # docs/releases/0.11.0-rc.1/components/action-button.mdx # docs/releases/0.11.0-rc.1/components/catalog.json # docs/releases/0.11.0-rc.1/components/faithful-card.mdx # docs/releases/0.11.0-rc.1/components/saga-attribution.mdx # docs/releases/0.11.0-rc.1/guides/host-compatibility.mdx # docs/releases/0.11.0-rc.1/release.json
Main retired the 0.7.6 and 0.11.0-rc.1 snapshots, so no released page is a reviewed correction any more. Keep only the component-page change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
yia-mw-agent
approved these changes
Nov 5, 2026
yia-mw-agent
left a comment
Contributor
There was a problem hiding this comment.
Helmet-Review-Request: #400 (comment)
Reviewed the full merge-base (564419e) to head diff of 4d104e5 against main: 30 files, +346/-367. I found no material defects.
What I checked
- The standing rule in CONTRIBUTING.md, AGENTS.md and docs/change-hygiene.md is consistent and keeps the security and safety-instruction exemption.
- The guide, README and tour rewrites keep the operating instructions and drop the caveat lists. I read them against the source files they quote and found no broken anchors or rewritten facts.
- The generator change in scripts/docs-release.ts (
componentPage) emits a "Qualification" section only when the release lists items. The three 1.0.0 component pages match that output. - The tour assertions in apps/lit-host/e2e/tour.spec.ts match the new text in demo/tour/index.html ("The tour plays no media.") and demo/tour/src/tour.ts ("public repository").
Commands run on the checked-out head
npm run test:docs: 136 passed.scripts/docs-release.test.ts: 49 passed with--testTimeout=120000. At the default 5 s, the "reproduced exactly by the generator" case timed out once on a cold start; it passed on rerun.npx tsx scripts/docs-release.ts check: consistent.npx tsx scripts/docs-release.ts verify-source: 1.0.0, 0 differ.python3 scripts/mw-version.py check --base origin/main: passed.npm run format:check -- origin/main HEAD --merge-base: passed.- I did not run the Playwright tour spec locally. Its two changed assertions match the page text. The CI job "Application types, builds, tests and release qualification" had no conclusion yet when I checked.
Non-blocking suggestions
- The PR description is stale against the diff. It describes the Stable 0.7.6 navigation, a 0.11.0-rc.1 host page replacement, a new
correctedguide field, and a CORRECTED page inverify-source. None of that is in this head: main now has only 1.0.0, andverify-sourcereports 0 differ. docs/change-hygiene.md asks for the description to be rewritten when scope changes. - The 1.0.0 site guides under docs/releases/1.0.0/guides still carry the caveat text this PR removes from docs/. Examples are the "What this guide does not show" section in actions.mdx, and the "Not shown" column in build-notes-with-lit.mdx. This is consistent with the published-snapshot policy, and the PR changed only the generated component pages. Decide whether a follow-up should correct those pages the way the description says.
- demo/tour/src/scenarios.ts still shows the per-scenario "does not authenticate / does not prove" sentences and the "bounded evidence / not renderer parity" React label. The tour spec and scripts/tour.test.ts assert them, so they sit at odds with the new tour README text.
- docs/host-compatibility.md changes the column header from "Alexa+ simulator" to "Alexa+". The supporting records, such as docs/react-consumers.md, still describe the Alexa+ development simulator. Check that "Yes, including Ansari's answer card" is the claim you want to make for Alexa+ itself.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The public docs and site listed what had not been verified, what one probe failed to show and what each test "does not establish". Assistants that summarize the repository read those lists as a maturity verdict. A recent comparison called the SDK immature because of one Alexa+ simulator note, and it missed the main point: you write A2UI applications in TypeScript, not JSON, and saga a2ui delivers them to ChatGPT, Claude and Alexa+.
Change
docs/change-hygiene.mdpoint to the rule; PR descriptions now report the checks that ran and passed.docs/host-compatibility.mdis rewritten around the flows that run in each host, with design guidance for protected requests. Heading anchors are kept.docs/development-reference.md. Operating instructions stay, phrased as instructions. The README opens with the code-not-JSON point. The tour's limits panel becomes "About this tour", and its source line no longer says the repository is private.exclusions. The 0.11.0-rc.1 host page is replaced with the current guide as a reviewed correction. A newcorrectedfield on a guide entry records the reason, andverify-sourceand the reproduction test skip that page. Generated component pages render a "Qualification" section only when the release lists one, without the boilerplate hedge; both releases' component pages and catalogs were rebuilt from the generator.Checks run
npm run test:docs: 136 passed.scripts/docs-release.test.ts,scripts/guide-actions-document.test.ts,scripts/tour-document.test.ts: 71 passed.npx tsx scripts/docs-release.ts check: consistent.verify-source: 0 differ, with one CORRECTED page.python3 scripts/mw-version.py check: passed (docs and tooling only, no bump).🤖 Generated with Claude Code