Fixed GitHub alignment issues and notes in AI#259
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 52 minutes and 20 seconds. ⌛ 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. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughTwo documentation files were updated: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/self-hosting/govern/plane-ai.md (1)
58-58: Consider capability-based wording instead of a hard parameter threshold.“1 trillion parameters” may become stale quickly and can be misread as a strict requirement. A capability/performance-based recommendation (with examples) would age better.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/self-hosting/govern/plane-ai.md` at line 58, Replace the hard numerical requirement sentence ("The custom model should have at least 1 trillion parameters for all Plane AI features to work reliably.") with capability-based wording that recommends performance criteria instead of a parameter count; e.g. describe target capabilities such as "comparable to current large multimodal foundation models, supporting high-quality instruction following, multi-turn context retention of X+k tokens, and reliable multimodal understanding," and optionally include example models or tiers (e.g., "models with demonstrated ≥Y perplexity/benchmarks or similar real-world task performance") so readers get actionable guidance without an explicit parameter threshold.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/self-hosting/govern/plane-ai.md`:
- Around line 44-46: The tip block line exceeds the 120-character Prettier
limit; reflow the long sentence inside the :::tip::: block into multiple shorter
lines (wrap the sentence describing LiteLLM and the use of the CUSTOM_LLM_*
variables and CUSTOM_LLM_PROVIDER=openai) so each markdown line is under 120
characters, preserving the same content and punctuation.
---
Nitpick comments:
In `@docs/self-hosting/govern/plane-ai.md`:
- Line 58: Replace the hard numerical requirement sentence ("The custom model
should have at least 1 trillion parameters for all Plane AI features to work
reliably.") with capability-based wording that recommends performance criteria
instead of a parameter count; e.g. describe target capabilities such as
"comparable to current large multimodal foundation models, supporting
high-quality instruction following, multi-turn context retention of X+k tokens,
and reliable multimodal understanding," and optionally include example models or
tiers (e.g., "models with demonstrated ≥Y perplexity/benchmarks or similar
real-world task performance") so readers get actionable guidance without an
explicit parameter threshold.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8d0dbda4-a014-4410-8434-b06b72a04a73
📒 Files selected for processing (2)
docs/self-hosting/govern/integrations/github.mddocs/self-hosting/govern/plane-ai.md
| :::tip | ||
| If you need to use an LLM that isn't from OpenAI or Anthropic — for example, an open-source model or a regional provider for compliance reasons — you can proxy it through [LiteLLM](https://docs.litellm.ai). LiteLLM exposes any LLM behind an OpenAI-compatible API, which Plane can then connect to using the `CUSTOM_LLM_*` variables with `CUSTOM_LLM_PROVIDER=openai`. | ||
| ::: |
There was a problem hiding this comment.
Wrap the tip text to keep markdown within formatting limits.
Line 45 is far beyond the configured markdown line width and is likely to fail/prevent consistent Prettier formatting.
💡 Proposed formatting fix
:::tip
-If you need to use an LLM that isn't from OpenAI or Anthropic — for example, an open-source model or a regional provider for compliance reasons — you can proxy it through [LiteLLM](https://docs.litellm.ai). LiteLLM exposes any LLM behind an OpenAI-compatible API, which Plane can then connect to using the `CUSTOM_LLM_*` variables with `CUSTOM_LLM_PROVIDER=openai`.
+If you need to use an LLM that isn't from OpenAI or Anthropic — for example,
+an open-source model or a regional provider for compliance reasons — you can
+proxy it through [LiteLLM](https://docs.litellm.ai). LiteLLM exposes any LLM
+behind an OpenAI-compatible API, which Plane can then connect to using the
+`CUSTOM_LLM_*` variables with `CUSTOM_LLM_PROVIDER=openai`.
:::As per coding guidelines, "**/*.{ts,tsx,js,jsx,vue,json,md,mts}: Prettier formatting checks must pass in CI, with 120 character line width, 2-space indent, semicolons, double quotes, and ES5 trailing commas`."
📝 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.
| :::tip | |
| If you need to use an LLM that isn't from OpenAI or Anthropic — for example, an open-source model or a regional provider for compliance reasons — you can proxy it through [LiteLLM](https://docs.litellm.ai). LiteLLM exposes any LLM behind an OpenAI-compatible API, which Plane can then connect to using the `CUSTOM_LLM_*` variables with `CUSTOM_LLM_PROVIDER=openai`. | |
| ::: | |
| :::tip | |
| If you need to use an LLM that isn't from OpenAI or Anthropic — for example, | |
| an open-source model or a regional provider for compliance reasons — you can | |
| proxy it through [LiteLLM](https://docs.litellm.ai). LiteLLM exposes any LLM | |
| behind an OpenAI-compatible API, which Plane can then connect to using the | |
| `CUSTOM_LLM_*` variables with `CUSTOM_LLM_PROVIDER=openai`. | |
| ::: |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/self-hosting/govern/plane-ai.md` around lines 44 - 46, The tip block
line exceeds the 120-character Prettier limit; reflow the long sentence inside
the :::tip::: block into multiple shorter lines (wrap the sentence describing
LiteLLM and the use of the CUSTOM_LLM_* variables and
CUSTOM_LLM_PROVIDER=openai) so each markdown line is under 120 characters,
preserving the same content and punctuation.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/self-hosting/govern/integrations/github.md`:
- Line 121: Update the capitalization of the product name in the sentence "These
URLs allow Plane to verify and enable workspace connection with the Github App."
— replace "Github" with the official "GitHub" (i.e., "These URLs allow Plane to
verify and enable workspace connection with the GitHub App.").
- Around line 39-93: Dedent the tab/content block so Markdown headings and
fences start at column 0: remove the extra leading spaces before the code fences
containing the callback and webhook URLs and before the "GitHub Cloud" / "GitHub
Enterprise Server" headings and any nested list lines; specifically fix the
three fenced blocks with "```bash" around the callback URLs and webhook URL and
the heading "#### GitHub Enterprise Server" so they are not indented, then run
Prettier to ensure CI formatting passes.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 60e61239-7452-48bc-b38e-f10a450e8675
📒 Files selected for processing (1)
docs/self-hosting/govern/integrations/github.md
| ``` | ||
|
|
||
| **For Plane cloud instance** | ||
| These URLs allow Plane to verify and enable workspace connection with the Github App. |
There was a problem hiding this comment.
Correct product name casing: Github → GitHub.
Line 121 should use the official capitalization for consistency and docs quality.
- These URLs allow Plane to verify and enable workspace connection with the Github App.
+ These URLs allow Plane to verify and enable workspace connection with the GitHub App.📝 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.
| These URLs allow Plane to verify and enable workspace connection with the Github App. | |
| These URLs allow Plane to verify and enable workspace connection with the GitHub App. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~121-~121: The official name of this software platform is spelled with a capital “H”.
Context: ...rkspace connection with the Github App. 
:::wa...
(GITHUB)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/self-hosting/govern/integrations/github.md` at line 121, Update the
capitalization of the product name in the sentence "These URLs allow Plane to
verify and enable workspace connection with the Github App." — replace "Github"
with the official "GitHub" (i.e., "These URLs allow Plane to verify and enable
workspace connection with the GitHub App.").
2 participants
Summary by CodeRabbit
Summary by CodeRabbit