docs: add hikaku usage guide and runnable example#157
Merged
Conversation
- Add examples/ directory with a Wikipedia search scenario and a helper script that drives the three hikaku phases (baseline, compare, report) - Update README with a full "Performance Regression Detection" section covering step-by-step usage, environment variables, LLM reporting options, and CI integration - Add hikaku env vars to the configuration reference table - Gitignore generated baseline and report files Co-Authored-By: Claude Opus 4.6 <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.
Summary
examples/directory with a ready-to-run scenario and helper script for the three hikaku phases (baseline → compare → report)Files
examples/scenario.yamlexamples/run.sh.gitignorebaseline.jsonandhikaku-report.mdREADME.mdHow to test
🤖 Generated with Claude Code