Repository navigation
docs: fix broken README badges and install buttons (DeepWiki, VS Code, add Cursor) - #829
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📜 Recent review details
📝 Summary
Merge Risk: ⚪ Minimal · up to The changes update client installation links and badges, with no concrete breakage established in the reviewed context. The PR appears mergeable subject to normal checks. Pre-merge checks |
  |
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage |  |
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (6 skipped: 6 … | Write docstrings for the functions missing them to satisfy the coverage threshold. |
✅ Passed checks (4 passed)
-
Check name Status Explanation Title check The title clearly identifies the broken README badges and install buttons, including DeepWiki, VS Code, and Cursor. Description check The description directly explains the badge fixes, VS Code redirect change, Cursor button addition, implementation details, and verification results. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (6 skipped: 6 unsupported.)
- Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
-
📝 Generate docstrings 💡
-
-
- Commit to this branch
- Create a new PR
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
✨ Simplify code
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
1 participant
What was broken
https://deepwiki.com/badge.svgnow returns HTTP 429text/html(a Vercel protection page) instead of an SVG, and GitHub's camo proxy returns 502, so the badge rendered as a broken image.vscode:mcp/install?.... GitHub strips non-http(s) links, so on github.com the badge only opened its own camo image and never launched VS Code.Fix
https://img.shields.io/badge/DeepWiki-Ask-blue). Link tohttps://deepwiki.com/zereight/gitlab-mcpunchanged.https://vscode.dev/redirect/mcp/install?name=zereight.gitlab-mcp&config=..., the same form used bygithub/github-mcp-serverandatlassian/atlassian-mcp-server. The install payload is unchanged (npx -y @zereight/mcp-gitlab@latest,${input:gitlab-token},GITLAB_API_URL,GITLAB_PERMISSION_MODE=full).docs/clients/cursor.md), using Cursor's official web install linkhttps://cursor.com/en/install-mcp?name=...&config=<base64>with the officialmcp-install-dark.svgbutton. Same server config, except the token is${env:GITLAB_PERSONAL_ACCESS_TOKEN}: Cursor only supports${env:...},${userHome},${workspaceFolder}interpolation, not VS Code's${input:...}.docs/clients/cursor.mdhas a one-line note about this.scripts/generate-vscode-install-link.mjsnow generates both badges. README/docs badge lines are byte-identical to its output.Verification
curlon the new image URLs:img.shields.io/badge/DeepWiki-Ask-blue→ 200image/svg+xml,cursor.com/deeplink/mcp-install-dark.svg→ 200image/svg+xml.vscode.dev/redirect/mcp/install?...→ 302 tovscode:mcp/install?{...same config..., "name":"zereight.gitlab-mcp"}.assets/star-history.png,docs/img/step *.png) checked OK, both directly and through the camo URLs on the rendered README. Left unchanged.npm run check:skill-syncpasses.mkdocs build --strictpasses.