-
Notifications
You must be signed in to change notification settings - Fork 434
Fix docs #770
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix docs #770
Conversation
Summary of ChangesHello @wangxingjun778, 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 focuses on enhancing the project's documentation by refining link texts and standardizing image embedding practices. The changes aim to improve the readability, consistency, and maintainability of the documentation across different language versions, ensuring a more uniform and accessible experience for users. Highlights
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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates documentation files. The changes include renaming a link from 'Docs' to 'Documentation' for clarity, adding a missing link to the Chinese documentation in the Chinese README, and converting HTML <img> tags to Markdown image syntax. While the move to pure Markdown for images is good for consistency, it removes specific styling like width and centering, which might impact the visual layout. I've added suggestions to address this and to improve language consistency in the Chinese README.
|
|
||
| <p align="center"> | ||
| <a href="https://modelscope.cn/mcp/playground">MCP Playground</a> | <a href="https://arxiv.org/abs/2309.00986">Paper</a> | <a href="https://ms-agent-en.readthedocs.io">Docs</a> | ||
| <a href="https://modelscope.cn/mcp/playground">MCP Playground</a> | <a href="https://arxiv.org/abs/2309.00986">Paper</a> | <a href="https://ms-agent-en.readthedocs.io">Documentation</a> | <a href="https://ms-agent.readthedocs.io/zh-cn">中文文档</a> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency within this Chinese document, it would be better to change the link text 'Documentation' to '英文文档'. This would make the link text consistent with the language of the document.
| <a href="https://modelscope.cn/mcp/playground">MCP Playground</a> | <a href="https://arxiv.org/abs/2309.00986">Paper</a> | <a href="https://ms-agent-en.readthedocs.io">Documentation</a> | <a href="https://ms-agent.readthedocs.io/zh-cn">中文文档</a> | |
| <a href="https://modelscope.cn/mcp/playground">MCP Playground</a> | <a href="https://arxiv.org/abs/2309.00986">Paper</a> | <a href="https://ms-agent-en.readthedocs.io">英文文档</a> | <a href="https://ms-agent.readthedocs.io/zh-cn">中文文档</a> |
docs/source/Projects/智能体技能.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Converting the <img> tag to Markdown image syntax ![]() causes the image to lose its original styling (e.g., width and centering). This might affect the layout and readability of the document. If preserving the image style is important, consider reverting to the <img> tag to retain the styling. This suggestion also applies to other similar changes in this file.
|  | |
| <img src="../../resources/skill_architecture.png" alt="Skill-Architecture" style="width: 750px; display: block; margin: 0 auto;" /> |
| - The Agent Skill Architecture | ||
|
|
||
| <img src="../../resources/skill_architecture.png" alt="Skill-Architecture" style="width: 750px; display: block; margin: 0 auto;" /> | ||
|  |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Converting the <img> tag to Markdown image syntax ![]() causes the image to lose its original styling (e.g., width and centering). This might affect the layout and readability of the document. If preserving the image style is important, consider reverting to the <img> tag to retain the styling. This suggestion also applies to other similar changes in this file.
|  | |
| <img src="../../resources/skill_architecture.png" alt="Skill-Architecture" style="width: 750px; display: block; margin: 0 auto;" /> |
No description provided.