docs: slim README to a Canonry-style overview, split details into docs/#43
Merged
Conversation
Cut the README from ~386 lines to ~70: a badge row, a bold value prop, capability bullets that link out, an immediate usage example, and a docs table. Moved the full detail into docs/cli.md (every flag, mode, exit code), docs/scoring.md (16 factors, weights, grading scale), docs/api.md (programmatic API), and docs/skill.md (the /aeo skill). Updated the CLAUDE.md doc-sync convention to point the CLI surface at docs/cli.md. Copy is minimal and em-dash free throughout. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The GitHub repository moved from the AINYC org to Canonry. Update every github.com/AINYC/aeo-audit reference (README, CONTRIBUTING, docs/skill.md, package.json repository + bugs URLs, skills/aeo/SKILL.md) and the local origin remote. Deliberately left unchanged: the @ainyc/aeo-audit npm scope (package identity, not moved), the ainyc.ai homepage, the LICENSE copyright entity, the AINYC-AEO-Audit User-Agent strings, and the historical CHANGELOG note. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Slims the README from ~386 to ~70 lines into a Canonry-style overview: a badge row, a bold value prop, capability bullets that link out, an immediate
npxusage example, and a documentation table. Moves the full detail into four new docs —docs/cli.md(every flag, mode, and exit code),docs/scoring.md(the 16 factors, weights, and grading scale),docs/api.md(the programmatic API), anddocs/skill.md(the/aeoskill and install) — and updates theCLAUDE.mddoc-sync convention so the CLI surface now lives indocs/cli.md. Also migrates everygithub.com/AINYC/aeo-auditreference togithub.com/Canonry/aeo-audit(README, CONTRIBUTING, docs,package.jsonrepository + bugs URLs,SKILL.md) following the repo's move to the Canonry org. Copy is minimal and em-dash free throughout; the@ainycnpm scope,ainyc.aihomepage, LICENSE entity, and bot User-Agent are intentionally unchanged, and no code, CLI, or scoring behavior changed.🤖 Generated with Claude Code