docs: reposition project as Cynosure Router#64
Closed
Disaster-Terminator wants to merge 2 commits intomainfrom
Closed
docs: reposition project as Cynosure Router#64Disaster-Terminator wants to merge 2 commits intomainfrom
Disaster-Terminator wants to merge 2 commits intomainfrom
Conversation
ⓘ 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. |
审阅者指南（Reviewer's Guide）将文档中项目的对外身份从 “Gateway Semantic Router” 调整为 “Cynosure Router”，重写 README（主要为中文），将其核心叙事聚焦在作为 LiteLLM 前面、具备意图感知能力的路由控制平面这一 “sidecar” 角色。同时新增 PROJECT_IDENTITY 文档，记录拟议项目名称、GitHub 元数据方面的推荐及迁移注意事项，但本 PR 不对任何实际仓库/平台元数据做改动。 Cynosure Router 路由决策与回退的时序图sequenceDiagram
actor Client
participant Router as CynosureRouter
participant Emb as EmbeddingService
participant GW as LiteLLMGateway
participant Prov as ModelProvider
Client->>Router: POST /v1/chat/completions model=semantic-router
Router->>Router: Inspect metadata_route_and_model
alt Non_entry_model
Router->>GW: Forward_request_passthrough
GW->>Prov: Execute_model
Prov-->>GW: Response
GW-->>Router: Response
Router-->>Client: Response_with_headers
else Entry_model
alt Metadata_explicit_route
Router->>Router: Use_metadata_route
else Chinese_hard_rules
Router->>Router: Match_high_risk_keywords
else Embedding_semantic_match
Router->>Emb: POST /v1/embeddings
Emb-->>Router: Embedding_vector
Router->>Router: Select_best_route_by_score
else Low_confidence
Router->>Router: Fallback_to_configured_route
end
Router->>Router: Rewrite_model_field_to_target_model
Router->>GW: Forward_rewritten_request
GW->>Prov: Execute_model
Prov-->>GW: Response
GW-->>Router: Response
Router->>Router: Log_route_complete_structured
Router-->>Client: Response_with_routing_headers
opt Embedding_error
Router->>Router: Mark_embedding_degraded_and_use_fallback_route
end
end
文件级变更（File-Level Changes）
提示与命令（Tips and commands）与 Sourcery 交互（Interacting with Sourcery）
自定义你的体验（Customizing Your Experience）打开你的 dashboard 以：
获取帮助（Getting Help）Original review guide in EnglishReviewer's GuideRepositions the documented project identity from “Gateway Semantic Router” to “Cynosure Router”, rewriting the README (primarily in Chinese) to center the sidecar’s role as an intent-aware routing control plane in front of LiteLLM, and adds a PROJECT_IDENTITY doc that captures the proposed name, GitHub metadata recommendations, and migration considerations without changing any actual repo/platform metadata. Sequence diagram for Cynosure Router routing decision and fallbacksequenceDiagram
actor Client
participant Router as CynosureRouter
participant Emb as EmbeddingService
participant GW as LiteLLMGateway
participant Prov as ModelProvider
Client->>Router: POST /v1/chat/completions model=semantic-router
Router->>Router: Inspect metadata_route_and_model
alt Non_entry_model
Router->>GW: Forward_request_passthrough
GW->>Prov: Execute_model
Prov-->>GW: Response
GW-->>Router: Response
Router-->>Client: Response_with_headers
else Entry_model
alt Metadata_explicit_route
Router->>Router: Use_metadata_route
else Chinese_hard_rules
Router->>Router: Match_high_risk_keywords
else Embedding_semantic_match
Router->>Emb: POST /v1/embeddings
Emb-->>Router: Embedding_vector
Router->>Router: Select_best_route_by_score
else Low_confidence
Router->>Router: Fallback_to_configured_route
end
Router->>Router: Rewrite_model_field_to_target_model
Router->>GW: Forward_rewritten_request
GW->>Prov: Execute_model
Prov-->>GW: Response
GW-->>Router: Response
Router->>Router: Log_route_complete_structured
Router-->>Client: Response_with_routing_headers
opt Embedding_error
Router->>Router: Mark_embedding_degraded_and_use_fallback_route
end
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - 我提供了一些整体性的反馈：
- README 和 docs/PROJECT_IDENTITY.md 在定位和命名方面有不少内容重叠；建议将权威的身份/定位说明集中放在一个地方，然后在另一个文档中引用它，这样在未来需要修改时可以减少两者之间的偏差。
- README 里仍然包含具体的本地路径，比如
/home/raystorm/gateway/gateway-semantic-router；为了避免被当成硬性要求直接复制粘贴，可以考虑将这些路径参数化（例如<project-root>），或者把它们移到一个专门的“示例部署”章节中。
给 AI Agent 的提示词
Please address the comments from this code review:
## Overall Comments
- README 和 docs/PROJECT_IDENTITY.md 在定位和命名方面有不少内容重叠；建议将权威的身份/定位说明集中放在一个地方，然后在另一个文档中引用它，这样在未来需要修改时可以减少两者之间的偏差。
- README 里仍然包含具体的本地路径，比如 `/home/raystorm/gateway/gateway-semantic-router`；为了避免被当成硬性要求直接复制粘贴，可以考虑将这些路径参数化（例如 `<project-root>`），或者把它们移到一个专门的“示例部署”章节中。帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈持续改进代码评审质量。
Original comment in English
Hey - I've left some high level feedback:
- There’s quite a bit of overlap between README and docs/PROJECT_IDENTITY.md around positioning and naming; consider consolidating the canonical identity/positioning in one place and referencing it from the other to reduce future drift when changes are needed.
- The README still embeds concrete local paths like
/home/raystorm/gateway/gateway-semantic-router; it may be clearer to either parameterize these (e.g.<project-root>) or move them into a dedicated “example deployment” section so they’re less likely to be copy-pasted as hard requirements.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- There’s quite a bit of overlap between README and docs/PROJECT_IDENTITY.md around positioning and naming; consider consolidating the canonical identity/positioning in one place and referencing it from the other to reduce future drift when changes are needed.
- The README still embeds concrete local paths like `/home/raystorm/gateway/gateway-semantic-router`; it may be clearer to either parameterize these (e.g. `<project-root>`) or move them into a dedicated “example deployment” section so they’re less likely to be copy-pasted as hard requirements.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README.mdin Chinese around the actual sidecar boundary: intent-aware routing control plane before LiteLLM execution.docs/PROJECT_IDENTITY.mdto record the proposed repository name, GitHub title, About description, topics, and migration notes.Notes
This PR intentionally does not change GitHub repository title, About description, repository name, topics, or other platform metadata. Those recommendations are recorded in
docs/PROJECT_IDENTITY.mdfor review first.Validation
Docs-only change; automated tests not run.
Summary by Sourcery
将文档中提到的项目重命名为 Cynosure Router，并重新定位 README，突出其作为部署在 LiteLLM 之前、具备意图识别能力的路由 sidecar 的角色，重点面向中文场景的文档，同时澄清生产环境与可观测性相关的工作流。
Documentation:
Original summary in English
Summary by Sourcery
Rename the documented project to Cynosure Router and reposition the README around its role as an intent-aware routing sidecar in front of LiteLLM, with Chinese-focused documentation and clarified production/observability workflows.
Documentation: