Skip to content

docs: document sitemap mode and add CLI doc-sync rule#24

Merged
arberx merged 1 commit intomainfrom
arberx/claude-md-cli-docs
Apr 27, 2026
Merged

docs: document sitemap mode and add CLI doc-sync rule#24
arberx merged 1 commit intomainfrom
arberx/claude-md-cli-docs

Conversation

@arberx
Copy link
Copy Markdown
Member

@arberx arberx commented Apr 27, 2026

Summary

  • Document sitemap mode (--sitemap, --limit, --top-issues) in the README, which previously only covered the basic flags. Adds a flag-reference table and notes the stderr truncation notice and sitemap-aggregate exit-code behavior.
  • Polish printHelp(): align the option column, surface bounded-concurrency and stderr-notice details, add the missing --include-agent-skills example, and append an exit-code footer.
  • Add a ## Documentation section to CLAUDE.md requiring any user-visible CLI change to update printHelp(), the README, and skills/aeo/SKILL.md together.

Test plan

  • pnpm run typecheck
  • pnpm run build and node bin/aeo-audit.js --help renders cleanly with aligned columns

🤖 Generated with Claude Code

…ync rule to CLAUDE.md

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@arberx arberx merged commit 380db34 into main Apr 27, 2026
2 checks passed
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