Update docs for vibe coding#192
Merged
Merged
Conversation
fuweid
approved these changes
Jul 18, 2025
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
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.
This pull request introduces comprehensive documentation updates and new files to improve the usability and understanding of the
kperfbenchmarking tool and its associated components. The changes include new guidance for tools like GitHub Copilot and Claude, detailed instructions for building, testing, and usingkperfandrunkperf, and setup documentation for Kubernetes clusters.Documentation Enhancements:
New Guidance for Tools:
.github/copilot-instructions.mdto provide GitHub Copilot with repository-specific guidance, including links to design, build, setup, and testing documentation.CLAUDE.mdto guide Claude Code (claude.ai/code) in navigating and working with the repository.Expanded Build and Setup Instructions:
docs/build.mdwith detailed steps for building, testing, and installingkperf, as well as container operations like image building and pushing.docs/setup.mdto provide cluster setup instructions for platforms like AKS, EKS, and GKE, including prerequisites and cleanup steps.Tool-Specific Documentation:
docs/kperf.mdto explainkperfusage, including commands for load generation, runner group management, and virtual cluster operations. Examples and YAML configurations are included.docs/runkperf.mdto include testing instructions forrunkperf, with updated build and setup guidance and benchmark scenario examples. [1] [2]General Improvements:
README Update:
README.mdwith a clearer explanation ofkperfandrunkperfcommands and their purposes, linking to the respective documentation for more details.Architecture Overview:
docs/design.mdto describe the architecture and components ofkperf, including CLI tools, core libraries, request types, load profiles, and virtual clusters.