Repository navigation
Propose the egm-explain plain-language explainer skill - #228
barkhagvalani wants to merge 2 commits into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
0c2e264 to
e8a43f4
Compare
|
Updated in 89d4d08: refresh now invalidates on child explainers, extra-source content, and output settings, including internal-to-shareable audience changes. Goldfish reviewers return findings read-only; the coordinator applies supported fixes. Synced current main and validated the revised design with all 138 offline unit tests plus git diff --check. Draft status is retained. Design-ready on #214 and the three listed maintainer decisions remain outstanding; this update does not claim a native skill implementation or rerun of /egm-review. |
Refs #214
Suggested label:
docsContribution Type
Please select the track that matches this pull request:
skills/oragents/; no design doc required)Refs #214| Addsdocs/designs/explain.mdand updatesdocs/designs/README.md)Summary of Key Changes
docs/designs/explain.md: the design for/egm-explain, a skill run after/egm-bootstrapthat writes a plain-languageEXPLAINER.mdbeside each meaningful README contract, plus a repository explainer with a shared glossary. Explainers are built only from contracts (never from code), carry Mermaid diagrams where they help, record their contract's hash for incremental refresh, and are checked by a fact-checker and theegm-comprehensionpersona.docs/designs/README.md: registers the design after the bootstrap row.The design includes results from a trial run on a production app (20 contracts → 15 explainers, 5 folded; 39 fact-check corrections) and the eight design changes that run produced. A working implementation exists and passes
tests/unitagainst EGM 0.1.0; I'll open it as the Stage 2 PR once this design is merged.The three open questions from #214 are repeated at the end of the doc.
Human Accountability Affirmation
Verification
/egm-review docs/designs/explain.md, resolved findings via/egm-resolve, and verified relative links (pytest tests/unit/test_link_integrity.py).test_scenarios.yamladded/updated andpytest tests/unitexecuted./egm-brainstorm,/egm-draft, and/egm-reviewon the target harness; attached execution summary or transcript.🤖 Generated with Claude Code