Skip to content

docs: fix Mermaid diagram parse error in search_flow_design#1456

Merged
earayu merged 1 commit intomainfrom
docs/fix-mermaid-search-flow-diagram
Mar 24, 2026
Merged

docs: fix Mermaid diagram parse error in search_flow_design#1456
earayu merged 1 commit intomainfrom
docs/fix-mermaid-search-flow-diagram

Conversation

@earayu
Copy link
Copy Markdown
Collaborator

@earayu earayu commented Mar 24, 2026

问题

GitHub 渲染 Mermaid 时,边标签中的 /collections/{id}/searches 会因花括号被解析为菱形节点语法而报错。

修改

  • 边标签改为 POST /api/v1/collections/<collection_id>/searches(双引号包裹)
  • 图下补充说明:与 OpenAPI {collection_id} 同义,并解释为何避免 {}

Made with Cursor

… label)

GitHub Mermaid treats unquoted { as diamond node start; use <collection_id>
in quoted edge text and add a short note linking to OpenAPI path form.

Made-with: Cursor
@earayu earayu merged commit 4716ffd into main Mar 24, 2026
3 of 4 checks passed
@apecloud-bot apecloud-bot added the size/XS Denotes a PR that changes 0-9 lines. label Mar 24, 2026
@earayu earayu deleted the docs/fix-mermaid-search-flow-diagram branch March 24, 2026 07:36
@apecloud-bot
Copy link
Copy Markdown
Collaborator

This branch name is not following the standards: feature/|bugfix/|release/|hotfix/|support/|releasing/|dependabot/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Denotes a PR that changes 0-9 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants