Skip to content

docs: use segmented README badges#66

Merged
Disaster-Terminator merged 4 commits intomainfrom
docs/readme-segment-badges
May 6, 2026
Merged

docs: use segmented README badges#66
Disaster-Terminator merged 4 commits intomainfrom
docs/readme-segment-badges

Conversation

@Disaster-Terminator
Copy link
Copy Markdown
Owner

@Disaster-Terminator Disaster-Terminator commented May 6, 2026

Summary

  • replace the previous large README badge cards with compact segmented Shields.io badges
  • add a second badge row for the lightweight stack: Python 3.11+, FastAPI, YAML, pytest, uv
  • remove internal/meta README wording and keep the deployment guidance product-facing
  • keep Chinese and English README badge blocks and wording aligned

Notes

This is documentation-only. It does not change runtime code, config, tests, secrets, or repository metadata.

Summary by Sourcery

刷新 README 文档,以使用紧凑分段徽章,并在英文和中文版本的 README 中澄清 IntentMux 与 LiteLLM 的部署和运行时行为。

Documentation:

  • 将 README 中的大型卡片式徽章替换为紧凑分段的 Shields.io 徽章,并新增一行,用于突出轻量级的 Python/FastAPI/YAML/pytest/uv 技术栈。
  • 在英文和中文文档中澄清部署指南,将 IntentMux 定位为 LiteLLM 的 sidecar,并强调将 provider 密钥和 LiteLLM 数据保存在代码仓库之外。
  • 优化对 semantic-router 入口及当前运行时行为/能力的说明,使英文和中文 README 之间的措辞保持一致。
Original summary in English

Summary by Sourcery

Refresh README documentation to use compact segmented badges and clarify deployment and runtime behavior for IntentMux alongside LiteLLM in both English and Chinese readmes.

Documentation:

  • Replace large card-style README badges with compact segmented Shields.io badges and add a second row highlighting the lightweight Python/FastAPI/YAML/pytest/uv stack.
  • Clarify deployment guidance to position IntentMux as a LiteLLM sidecar and keep provider secrets and LiteLLM data outside the repository, in both English and Chinese documentation.
  • Refine explanations of the semantic-router entry and current runtime behavior/capabilities, aligning wording between the English and Chinese READMEs.

@qodo-code-review
Copy link
Copy Markdown

ⓘ You've reached your Qodo monthly free-tier limit. Reviews pause until next month — upgrade your plan to continue now, or link your paid account if you already have one.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 6, 2026

🧙 Sourcery 已完成对你 Pull Request 的审核!


提示与命令

与 Sourcery 交互

  • 触发新的审核: 在 Pull Request 中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审核评论。
  • 从审核评论生成 GitHub issue: 通过回复某条审核评论,要求 Sourcery 从该评论创建一个 issue。你也可以在审核评论下回复 @sourcery-ai issue 来从该评论创建一个 issue。
  • 生成 Pull Request 标题: 在 Pull Request 标题的任意位置写上 @sourcery-ai,即可随时生成标题。你也可以在 Pull Request 中评论 @sourcery-ai title 来随时(重新)生成标题。
  • 生成 Pull Request 摘要: 在 Pull Request 正文的任意位置写上 @sourcery-ai summary,即可在你想要的位置随时生成 PR 摘要。你也可以在 Pull Request 中评论 @sourcery-ai summary 来随时(重新)生成摘要。
  • 生成审阅者指南: 在 Pull Request 中评论 @sourcery-ai guide,即可随时(重新)生成审阅者指南。
  • 解决所有 Sourcery 评论: 在 Pull Request 中评论 @sourcery-ai resolve,即可将所有 Sourcery 评论标记为已解决。如果你已经处理完所有评论且不想再看到它们,这会很有用。
  • 忽略所有 Sourcery 审核: 在 Pull Request 中评论 @sourcery-ai dismiss,即可忽略所有现有的 Sourcery 审核。若你想从头开始一次全新的审核,这尤其有用——别忘了再评论 @sourcery-ai review 来触发新的审核!

自定义你的使用体验

前往你的 dashboard 以:

  • 启用或禁用审核功能,例如 Sourcery 生成的 Pull Request 摘要、审阅者指南等。
  • 更改审核语言。
  • 添加、移除或编辑自定义审核说明。
  • 调整其他审核设置。

获取帮助

Original review guide in English

🧙 Sourcery has finished reviewing your pull request!


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

嗨——我已经审查了你的修改,看起来非常棒!


Sourcery 对开源项目是免费的——如果你觉得我们的审查有帮助,欢迎分享 ✨
帮我变得更有用!请在每条评论上点 👍 或 👎,我会根据你的反馈来改进后续的审查。
Original comment in English

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Disaster-Terminator Disaster-Terminator merged commit 89f7384 into main May 6, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant