Skip to content

docs: move sample report to examples/ and clean up README install section - #1

Merged
thedoublejay merged 2 commits into
mainfrom
docs/sample-report-and-readme-cleanup
Apr 9, 2026
Merged

docs: move sample report to examples/ and clean up README install section#1
thedoublejay merged 2 commits into
mainfrom
docs/sample-report-and-readme-cleanup

Conversation

@thedoublejay

@thedoublejay thedoublejay commented Apr 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Renames BENCHMARK.mdexamples/sample-report.md — clearer name that signals "this is what output looks like" to new users browsing the repo
  • Removes the broken /install thedoublejay/please-optimize-my-claude plugin command from the Quick Start section (not yet available in marketplace)
  • Makes skills.sh the single recommended install path
  • Adds a Sample Report section in the README with a link to examples/sample-report.md

Test plan

  • Verify examples/sample-report.md renders correctly on GitHub
  • Confirm README install section no longer references the broken /install command
  • Confirm README links to examples/sample-report.md resolve correctly

…tion

- Rename BENCHMARK.md → examples/sample-report.md for clarity
- Replace "Acme Corp" with "Mavs Org" throughout sample report
- Remove broken /install plugin command from Quick Start
- Make skills.sh the recommended (only) install path
- Add Sample Report section in README linking to examples/
@thedoublejay
thedoublejay merged commit 22435d5 into main Apr 9, 2026
1 check 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