Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThe AI credits documentation undergoes substantial simplification, removing complex explanations regarding credit drivers, plan-specific allocations, rollover rules, onboarding bonuses, pooling mechanics, and top-up structures. The content is replaced with a streamlined model covering per-seat credit allocation, optional workspace overage, and significantly reduced FAQs. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/ai/plane-ai-credits.md (1)
44-44: Tighten phrasing for readability.Line 44 is slightly wordy; a shorter phrasing reads cleaner.
✏️ Proposed wording
-- Admins stay in control of whether overage is allowed. +- Admins control whether overage is allowed.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/ai/plane-ai-credits.md` at line 44, The sentence "Admins stay in control of whether overage is allowed." is wordy; replace it with a tighter phrasing such as "Admins control whether overage is allowed." to improve readability—locate that exact sentence in docs/ai/plane-ai-credits.md and update it accordingly (search for the original sentence text to find the spot).
🤖 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/ai/plane-ai-credits.md`:
- Line 34: The sentence starting "If a member (or your workspace's included
capacity) runs out of available credits..." mixes seat-level and workspace
semantics; rewrite it to be explicit about the scope (preferably seat-level
only) and remove the workspace-capacity clause so it aligns with "no default
pooling" language, then add a short clause about overage behavior (e.g., AI
usage stops for that seat unless overage is enabled) and ensure the updated
phrasing replaces the current line.
- Line 6: The H1 in the markdown currently reads "Plane AI credits" but the
VitePress sidebar label is "AI credits"; update the H1 in the markdown file to
exactly "AI credits" to match the sidebar label (or alternatively update the
sidebar label to "Plane AI credits"), ensuring the top-level heading string and
the VitePress sidebar label are identical; locate the H1 "Plane AI credits" in
the markdown and change it to "AI credits" (or make the corresponding change to
the sidebar label entry named "AI credits" in the VitePress config) so they are
consistent.
---
Nitpick comments:
In `@docs/ai/plane-ai-credits.md`:
- Line 44: The sentence "Admins stay in control of whether overage is allowed."
is wordy; replace it with a tighter phrasing such as "Admins control whether
overage is allowed." to improve readability—locate that exact sentence in
docs/ai/plane-ai-credits.md and update it accordingly (search for the original
sentence text to find the spot).
🪄 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: 04b5fa31-e2d4-4190-babd-23b6d725809c
📒 Files selected for processing (1)
docs/ai/plane-ai-credits.md
| description: Understand seat-based AI credits, what happens when included credits run out, and how workspace overage keeps your team moving. | ||
| --- | ||
|
|
||
| # Plane AI credits |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify the H1 in docs/ai/plane-ai-credits.md and inspect sidebar labels in VitePress config.
set -euo pipefail
echo "== H1 in docs/ai/plane-ai-credits.md =="
sed -n '1,40p' docs/ai/plane-ai-credits.md | rg -n '^# '
echo
echo "== Potential sidebar references in docs/.vitepress/config.ts =="
rg -n -C2 'plane-ai-credits|Plane AI credits|How Plane AI credits work|/ai/' docs/.vitepress/config.tsRepository: makeplane/docs
Length of output: 406
H1 heading "Plane AI credits" does not match the sidebar label "AI credits".
The page heading on line 6 must be updated to match the sidebar label defined in docs/.vitepress/config.ts (line 627). Either rename the H1 to "AI credits" or update the sidebar label to "Plane AI credits"—both must be consistent per coding guidelines.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/ai/plane-ai-credits.md` at line 6, The H1 in the markdown currently
reads "Plane AI credits" but the VitePress sidebar label is "AI credits"; update
the H1 in the markdown file to exactly "AI credits" to match the sidebar label
(or alternatively update the sidebar label to "Plane AI credits"), ensuring the
top-level heading string and the VitePress sidebar label are identical; locate
the H1 "Plane AI credits" in the markdown and change it to "AI credits" (or make
the corresponding change to the sidebar label entry named "AI credits" in the
VitePress config) so they are consistent.
| ## What happens when included credits run out | ||
|
|
||
| ## Credit consumption patterns | ||
| If a member (or your workspace's included capacity) runs out of available credits for the billing period, AI usage can stop unless overage is enabled. |
There was a problem hiding this comment.
Clarify the scope of “runs out” to avoid mixed seat vs workspace semantics.
Line 34 currently blends per-member and workspace capacity language, which can read as contradictory with “no default pooling.” Consider using one explicit model statement here (seat-level only, plus overage behavior).
✏️ Proposed wording
-If a member (or your workspace's included capacity) runs out of available credits for the billing period, AI usage can stop unless overage is enabled.
+If a seat exhausts its included credits for the billing period, AI usage for that seat can stop unless workspace overage is enabled.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/ai/plane-ai-credits.md` at line 34, The sentence starting "If a member
(or your workspace's included capacity) runs out of available credits..." mixes
seat-level and workspace semantics; rewrite it to be explicit about the scope
(preferably seat-level only) and remove the workspace-capacity clause so it
aligns with "no default pooling" language, then add a short clause about overage
behavior (e.g., AI usage stops for that seat unless overage is enabled) and
ensure the updated phrasing replaces the current line.
2 participants
Motivation
Description
docs/ai/plane-ai-credits.mdto explain that credits are assigned per paid seat and to point readers tohttps://plane.so/pricing#ai-&-creditsfor current included amounts.Testing
pnpm check:formatin thedocsrepo and the formatting check passed successfully.Codex Task
Summary by CodeRabbit