Skip to content
Merged

Devv #406

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<img src="./imgs/llmc.png" alt="llmc" width="75%" />

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://github.com/ModelTC/llmc)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The link for the 'Ask DeepWiki' badge points back to the repository itself, which is not helpful for users. It should likely point to the project's page on DeepWiki. Based on DeepWiki's common URL structure, the link should probably be https://deepwiki.com/repo/ModelTC/llmc.

Suggested change
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://github.com/ModelTC/llmc)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/repo/ModelTC/llmc)

[![arXiv](https://img.shields.io/badge/LLMC-2405.06001-b31b1b)](https://arxiv.org/abs/2405.06001)
[![GitHub Stars](https://img.shields.io/github/stars/ModelTC/llmc.svg?style=social&label=Star&maxAge=60)](https://github.com/ModelTC/llmc)
![visitors](https://komarev.com/ghpvc/?username=llmc&label=visitors)
Expand Down
1 change: 1 addition & 0 deletions README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<img src="./imgs/llmc.png" alt="llmc" width="75%" />

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://github.com/ModelTC/llmc)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The link for the 'Ask DeepWiki' badge points back to the repository itself, which is not helpful for users. It should likely point to the project's page on DeepWiki. Based on DeepWiki's common URL structure, the link should probably be https://deepwiki.com/repo/ModelTC/llmc.

Suggested change
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://github.com/ModelTC/llmc)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/repo/ModelTC/llmc)

[![arXiv](https://img.shields.io/badge/LLMC-2405.06001-b31b1b)](https://arxiv.org/abs/2405.06001)
[![GitHub Stars](https://img.shields.io/github/stars/ModelTC/llmc.svg?style=social&label=Star&maxAge=60)](https://github.com/ModelTC/llmc)
![visitors](https://komarev.com/ghpvc/?username=llmc&label=visitors)
Expand Down
1 change: 1 addition & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
<img src="./imgs/llmc.png" alt="llmc" width="75%" />

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://github.com/ModelTC/llmc)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The link for the 'Ask DeepWiki' badge points back to the repository itself, which is not helpful for users. It should likely point to the project's page on DeepWiki. Based on DeepWiki's common URL structure, the link should probably be https://deepwiki.com/repo/ModelTC/llmc.

Suggested change
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://github.com/ModelTC/llmc)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/repo/ModelTC/llmc)

[![arXiv](https://img.shields.io/badge/LLMC-2405.06001-b31b1b)](https://arxiv.org/abs/2405.06001)
[![GitHub Stars](https://img.shields.io/github/stars/ModelTC/llmc.svg?style=social&label=Star&maxAge=60)](https://github.com/ModelTC/llmc)
![visitors](https://komarev.com/ghpvc/?username=llmc&label=visitors)
Expand Down
2 changes: 2 additions & 0 deletions requirements/docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ myst-parser == 2.0.0
sphinx-argparse
sphinxcontrib.redoc
sphinxcontrib.openapi
sphinxcontrib-katex
sphinxcontrib.contentui

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The package name sphinxcontrib.contentui is incorrect and will cause the pip install command to fail. The correct package name on PyPI is sphinxcontrib-contentui (with a hyphen). While it is referenced as sphinxcontrib.contentui in conf.py (which is correct for Sphinx extensions), the package name for installation must be corrected here.

sphinxcontrib-contentui