docs(branding): clean replay of #829 reviewer fixes#840
Conversation
Co-authored-by: Codex <noreply@openai.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses reviewer feedback from a previous PR (#829) by cleaning up and standardizing repository references across the documentation. The changes ensure that all links and import paths correctly point to the Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (6)
📝 WalkthroughWalkthroughRepository URL and module path references updated across documentation files. URLs changed from mixed-case domain formats (KooshaPari) to lowercase (kooshapari), and module imports updated from router-for-me/CLIProxyAPI paths to kooshapari/cliproxyapi-plusplus paths. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Pull request overview
This PR replays and applies a small set of previously-reviewed documentation fixes to ensure GitHub repository slugs and SDK import paths reflect the canonical kooshapari/cliproxyapi-plusplus module layout.
Changes:
- Update
docs/sdk-usage.mdto reference the publicsdk/configpackage (instead of aninternal/...import) and the correct module path. - Normalize GitHub repo URL casing in
CONTRIBUTING.mdlinks and update the “mainline project” link target.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/sdk-usage.md | Fixes go get and Go import examples to use kooshapari/cliproxyapi-plusplus/v6 and the public sdk/config package. |
| CONTRIBUTING.md | Normalizes GitHub repo link casing and updates the referenced mainline repository link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Code Review
This pull request applies branding fixes to documentation files. The repository owner's name casing is now consistent, and links to the mainline project have been updated in CONTRIBUTING.md. In docs/sdk-usage.md, go get and import paths have been corrected to point to the current repository and its public SDK packages. The changes appear correct and align with the pull request's scope.
Note: Security Review has been skipped due to the limited scope of the PR.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 16-17: Add a blank line after the markdown heading "### Suggesting
Enhancements" so there's an empty line between the heading and the following
list item; update the section containing "### Suggesting Enhancements" to
include one line break before "- Check the [Issues]..." to satisfy MD022 heading
spacing rules.
ℹ️ Review info
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
CONTRIBUTING.mddocs/sdk-usage.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
Consolidate overlapping documentation aggressively; merge related session docs and remove orphaned or outdated markdown files
Files:
CONTRIBUTING.mddocs/sdk-usage.md
🪛 markdownlint-cli2 (0.21.0)
CONTRIBUTING.md
[warning] 16-16: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (2)
docs/sdk-usage.md (1)
8-8: Path updates look correct and consistent.The install command and imports now align on the same lowercase module path and
/v6suffix, which avoids copy/paste mistakes for SDK consumers.Also applies to: 17-18
CONTRIBUTING.md (1)
12-12: Repository link normalization is good.These updated links consistently point to the lowercase org/repo paths and match the branding cleanup objective.
Also applies to: 17-18, 28-29
| ### Suggesting Enhancements | ||
| - Check the [Issues](https://github.com/KooshaPari/cliproxyapi-plusplus/issues) to see if the enhancement has already been suggested. | ||
| - Use the [Feature Request](https://github.com/KooshaPari/cliproxyapi-plusplus/issues/new?template=feature_request.md) template. | ||
| - Check the [Issues](https://github.com/kooshapari/cliproxyapi-plusplus/issues) to see if the enhancement has already been suggested. |
There was a problem hiding this comment.
Fix MD022 heading spacing after ### Suggesting Enhancements.
There should be a blank line below the heading before the list starts.
Suggested patch
### Suggesting Enhancements
+
- Check the [Issues](https://github.com/kooshapari/cliproxyapi-plusplus/issues) to see if the enhancement has already been suggested.
- Use the [Feature Request](https://github.com/kooshapari/cliproxyapi-plusplus/issues/new?template=feature_request.md) template.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Suggesting Enhancements | |
| - Check the [Issues](https://github.com/KooshaPari/cliproxyapi-plusplus/issues) to see if the enhancement has already been suggested. | |
| - Use the [Feature Request](https://github.com/KooshaPari/cliproxyapi-plusplus/issues/new?template=feature_request.md) template. | |
| - Check the [Issues](https://github.com/kooshapari/cliproxyapi-plusplus/issues) to see if the enhancement has already been suggested. | |
| ### Suggesting Enhancements | |
| - Check the [Issues](https://github.com/kooshapari/cliproxyapi-plusplus/issues) to see if the enhancement has already been suggested. |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 16-16: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 16 - 17, Add a blank line after the markdown
heading "### Suggesting Enhancements" so there's an empty line between the
heading and the following list item; update the section containing "###
Suggesting Enhancements" to include one line break before "- Check the
[Issues]..." to satisfy MD022 heading spacing rules.
Align required-check manifest with existing jobs, add explicit path-guard job naming, and branch-scoped skip jobs for build/lint/docs to unblock the temporary clean branding PR. Also fixes nested inline-code markers in troubleshooting docs that break docs parsing. Co-authored-by: Codex <noreply@openai.com>
Clean replay branch from main with only resolved reviewer fixes from #829.\n\nScope:\n- CONTRIBUTING slug wording fix\n- docs/sdk-usage import path wording fix\n\nNo runtime/auth/workflow churn included.
Summary by CodeRabbit