[readme] fix readme#3
Conversation
![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 comments out documentation badges and links in both README.md and README_zh.md. The feedback received suggests removing these lines entirely rather than leaving them commented out to maintain the cleanliness and readability of the documentation files.
| <img src="https://img.shields.io/badge/pytorch-%E2%89%A52.0-orange.svg"> | ||
| <a href="https://github.com/NVIDIA/Megatron-LM/"><img src="https://img.shields.io/badge/megatron--core-%E2%89%A50.12-76B900.svg"></a> | ||
| <a href="https://mcore-bridge.readthedocs.io/en/latest/"><img src="https://img.shields.io/badge/docs-latest-blue.svg"></a> | ||
| <!-- <a href="https://mcore-bridge.readthedocs.io/en/latest/"><img src="https://img.shields.io/badge/docs-latest-blue.svg"></a> --> |
There was a problem hiding this comment.
To maintain a clean and readable README, it's better to remove this commented-out line entirely. If the documentation is not yet ready, the link can be re-added in a future pull request when it becomes available.
| <!-- <p align="center"> | ||
| <a href="https://mcore-bridge.readthedocs.io/en/latest/">English Documentation</a>   ｜   <a href="https://mcore-bridge.readthedocs.io/zh-cn/latest/">中文文档</a>   | ||
| </p> | ||
| </p> --> |
There was a problem hiding this comment.
Similar to the above, this commented-out block should be removed to keep the README clean. It can be restored in a future change when the documentation links are working.
| <img src="https://img.shields.io/badge/pytorch-%E2%89%A52.0-orange.svg"> | ||
| <a href="https://github.com/NVIDIA/Megatron-LM/"><img src="https://img.shields.io/badge/megatron--core-%E2%89%A50.12-76B900.svg"></a> | ||
| <a href="https://mcore-bridge.readthedocs.io/en/latest/"><img src="https://img.shields.io/badge/docs-latest-blue.svg"></a> | ||
| <!-- <a href="https://mcore-bridge.readthedocs.io/en/latest/"><img src="https://img.shields.io/badge/docs-latest-blue.svg"></a> --> |
There was a problem hiding this comment.
To maintain a clean and readable README, it's better to remove this commented-out line entirely. If the documentation is not yet ready, the link can be re-added in a future pull request when it becomes available.
| <!-- <p align="center"> | ||
| <a href="https://mcore-bridge.readthedocs.io/en/latest/">English Documentation</a>   ｜   <a href="https://mcore-bridge.readthedocs.io/zh-cn/latest/">中文文档</a>   | ||
| </p> | ||
| </p> --> |
There was a problem hiding this comment.
Similar to the above, this commented-out block should be removed to keep the README clean. It can be restored in a future change when the documentation links are working.
1 participant
No description provided.