docs: Add architecture diagram and reorganize README structure#159
docs: Add architecture diagram and reorganize README structure#159dawid-nowak merged 12 commits intokmesh-net:mainfrom
Conversation
Summary of ChangesHello @JameelHao, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's documentation by introducing a comprehensive architecture section, complete with a professional diagram and detailed explanations of core components and design principles. It also reorganizes the main Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly improves the project's documentation by adding a new CODE_OF_CONDUCT.md file and extensively reorganizing the README.md. The new architecture section, complete with a diagram and detailed descriptions of components and design principles, is a great addition that will help new users and contributors understand the project. The overall structure is now more logical. I've included a couple of minor suggestions to further improve the documentation's presentation and robustness.
- Follow CNCF Code of Conduct - Consistent with Kmesh community standards - Same contact email for the Kmesh ecosystem Signed-off-by: JameelHao <haoxing12311@gmail.com>
- Add comprehensive architecture diagram (ASCII art) - Document core components and their responsibilities - Explain xDS integration and data flow - Highlight key design principles (zero-copy, async, memory safety) - Follow Kmesh README style Signed-off-by: JameelHao <haoxing12311@gmail.com>
…ssional diagram Signed-off-by: JameelHao <haoxing12311@gmail.com>
Signed-off-by: JameelHao <haoxing12311@gmail.com>
Signed-off-by: JameelHao <haoxing12311@gmail.com>
Signed-off-by: JameelHao <haoxing12311@gmail.com>
Signed-off-by: JameelHao <haoxing12311@gmail.com>
…ples Signed-off-by: JameelHao <haoxing12311@gmail.com>
- Add 4 benchmark charts in a 2x2 table layout - Show HTTP and HTTPS benchmark results (RPS and Latency) - Provide visual evidence of 2-4x performance improvement over Envoy Signed-off-by: JameelHao <haoxing12311@gmail.com>
Keep the documentation focused on core technical strengths. Can be added back in future releases with supporting evidence. Signed-off-by: JameelHao <haoxing12311@gmail.com>
- Adopt kmesh's lightweight PR template format - Use /kind labels (bug, feature, enhancement, etc.) - Add /kind performance for performance-related PRs - Include release-note section for user-facing changes Based on: https://github.com/kmesh-net/kmesh/blob/main/.github/PULL_REQUEST_TEMPLATE.md Signed-off-by: JameelHao <haoxing12311@gmail.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages. The list of commits with invalid commit messages:
DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: dawid-nowak The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Pull request overview
This PR enhances the Orion Proxy documentation by adding a comprehensive architecture section with a professional diagram and reorganizing the README for better readability. The changes align with professional open source project standards by improving documentation clarity and adding community guidelines.
Changes:
- Added Architecture section with diagram and detailed descriptions of core components and design principles
- Added performance benchmark visualization tables to the Key Features section
- Reorganized README structure to follow Introduction → Architecture → Quick Start flow
- Added CODE_OF_CONDUCT.md referencing CNCF Code of Conduct
- Added standardized pull request template for contributors
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Major restructuring with new architecture section, performance tables, and improved documentation flow |
| CODE_OF_CONDUCT.md | New file establishing community conduct guidelines following CNCF standards |
| .github/PULL_REQUEST_TEMPLATE.md | New standardized template for pull requests with common fields and release notes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - name: ORION_CPU_LIMIT | ||
| valueFrom: | ||
| resourceFieldRef: | ||
| resource: limits.cpu | ||
| divisor: "1" |
There was a problem hiding this comment.
The YAML indentation is inconsistent. This code block mixes 2-space and 4-space indentation, which can cause parsing issues. The Kubernetes YAML standard and other YAML files in this repository use consistent 2-space indentation. The indentation should be:
- name:should be indented with 2 spacesvalueFrom:should be indented with 4 spaces (2 more than the list item)resourceFieldRef:should be indented with 6 spacesresource:anddivisor:should be indented with 8 spaces
| - name: ORION_CPU_LIMIT | |
| valueFrom: | |
| resourceFieldRef: | |
| resource: limits.cpu | |
| divisor: "1" | |
| - name: ORION_CPU_LIMIT | |
| valueFrom: | |
| resourceFieldRef: | |
| resource: limits.cpu | |
| divisor: "1" |
| ## Quick Start | ||
|
|
||
| **Note:** To control how many CPU cores/threads Orion uses (especially in containers), set the `ORION_CPU_LIMIT` environment variable. In Kubernetes, use the Downward API: | ||
| <img src="docs/pics/architecture/orion_architecture.png" alt="Orion Architecture" style="zoom: 80%;" /> |
There was a problem hiding this comment.
Inline HTML styles are not supported by GitHub's markdown renderer and will be ignored. The style="zoom: 80%;" attribute will have no effect on GitHub. Consider removing the style attribute or using an alternative approach such as setting the width attribute or hosting the image at the desired size.
3 participants
Summary
This PR adds a comprehensive architecture section to the README with a professional diagram, and reorganizes the documentation structure for better readability.
Changes
Files Changed
README.md- Major update with architecture section (+55/-42 lines)docs/pics/architecture/orion_architecture.png- New architecture diagram (447 KB, 300 DPI)CODE_OF_CONDUCT.md- Community code of conductArchitecture Diagram Features
Impact