Mooncake
Mooncake copied to clipboard
[doc]merge doc to docs,and change all internal links to blog.
…ct to blog
Description
Motivation:
- Regarding the issues#1060 mentioned earlier, the content and responsibilities of the doc and docs documents overlap, making the cost of maintaining both sets of content higher.
Solution:
- Merge doc/en into docs, remove duplicates, and categorize new content, and change all internal links redirect to blog.
Changes:
- Place
doc/en/ascend_direct_transport.md,doc/en/ascend_transport.md, anddoc/en/heterogeneous_ascend.mdin theDesign document/Transfer Enginedirectory - Place
doc/en/Mooncake EPin theDesign documentdirectory. doc/en/transfer-engine-bench-tuning.mdanddocs/source/design/transfer-engine.mdcontain largely duplicate content; it is recommended to delete them.- Delete all others, include all Chinese documentation. Please refer to: https://github.com/Keithwwa/Mooncake/wiki/doc%E5%90%88%E5%B9%B6%E8%87%B3docs%EF%BC%8C%E7%BB%93%E6%9E%84%E8%B0%83%E6%95%B4
- Change all internal links redirect to blog,side from NIXL, because it doesn't provide an document website.
Type of Change
- Types
- [ ] Bug fix
- [ ] New feature
- [ ] Transfer Engine
- [ ] Mooncake Store
- [ ] Mooncake EP
- [ ] Integration
- [ ] P2P Store
- [ ] Python Wheel
- [ ] Breaking change
- [ ] CI/CD
- [x] Documentation update
- [ ] Other
How Has This Been Tested?
the Design Documents after changed:
Checklist
- [x] I have performed a self-review of my own code.
- [x] I have updated the documentation.
- [ ] I have added tests to prove my changes are effective.
Summary of Changes
Hello @Keithwwa, I'm Gemini Code Assist[^1]! 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 refactors the project's documentation by merging the 'doc/en' directory into the main 'docs' structure. The primary goal is to streamline content, eliminate redundancy, and improve the overall discoverability and maintainability of the project's guides and design documents. A key aspect of this change involves updating all internal references to point to the new, unified documentation platform, ensuring that users are always directed to the most current and relevant information.
Highlights
- Documentation Consolidation: The 'doc/en' directory has been merged into the 'docs' structure, centralizing English documentation and removing redundant content.
- Content Reorganization: Existing documentation has been re-categorized for better organization and clarity, making it easier to navigate.
- Internal Link Updates: All internal documentation links have been updated to redirect to the new blog-based documentation website, enhancing navigation and consistency across the project.
- File Restructuring: Numerous old documentation files, including both English and Chinese versions, have been removed or renamed as part of the consolidation effort.
Using Gemini Code Assist
The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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 :thumbsup: and :thumbsdown: 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.
[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.