Skip to content

Update docs for vibe coding#192

Merged
fuweid merged 4 commits into
mainfrom
update-docs-for-vibe-coding
Jul 18, 2025
Merged

Update docs for vibe coding#192
fuweid merged 4 commits into
mainfrom
update-docs-for-vibe-coding

Conversation

@anson627
Copy link
Copy Markdown
Contributor

This pull request introduces comprehensive documentation updates and new files to improve the usability and understanding of the kperf benchmarking tool and its associated components. The changes include new guidance for tools like GitHub Copilot and Claude, detailed instructions for building, testing, and using kperf and runkperf, and setup documentation for Kubernetes clusters.

Documentation Enhancements:

  • New Guidance for Tools:

    • Added .github/copilot-instructions.md to provide GitHub Copilot with repository-specific guidance, including links to design, build, setup, and testing documentation.
    • Added CLAUDE.md to guide Claude Code (claude.ai/code) in navigating and working with the repository.
  • Expanded Build and Setup Instructions:

    • Introduced docs/build.md with detailed steps for building, testing, and installing kperf, as well as container operations like image building and pushing.
    • Added docs/setup.md to provide cluster setup instructions for platforms like AKS, EKS, and GKE, including prerequisites and cleanup steps.

Tool-Specific Documentation:

  • Detailed Usage Guides:
    • Created docs/kperf.md to explain kperf usage, including commands for load generation, runner group management, and virtual cluster operations. Examples and YAML configurations are included.
    • Updated docs/runkperf.md to include testing instructions for runkperf, with updated build and setup guidance and benchmark scenario examples. [1] [2]

General Improvements:

  • README Update:

    • Enhanced the README.md with a clearer explanation of kperf and runkperf commands and their purposes, linking to the respective documentation for more details.
  • Architecture Overview:

    • Added docs/design.md to describe the architecture and components of kperf, including CLI tools, core libraries, request types, load profiles, and virtual clusters.

@fuweid fuweid merged commit f30d520 into main Jul 18, 2025
4 checks passed
@vittoriasalim vittoriasalim deleted the update-docs-for-vibe-coding branch August 6, 2025 04:55
@vittoriasalim vittoriasalim restored the update-docs-for-vibe-coding branch August 6, 2025 04:55
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.

2 participants