Project Releases, Audit logs, editor blocks, widgets - #486
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reached
Next review available in: 53 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (7)
📝 WalkthroughWalkthroughDocumentation updates add AI usage guidance, project release and audit-log pages, expanded issue and PQL references, Business page-block and dashboard documentation, and Microsoft Office attachment editing guidance. Sidebar navigation now exposes the new pages and separates workspace and project content. ChangesAI usage documentation
Release and audit documentation
Issue labels
Plane Query Language
Page editor blocks
Dashboard widgets
Microsoft Office editing
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
📝 Generate docstrings
🧪 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 |
vihar
approved these changes
Aug 12, 2026
sriramveeraghanta
approved these changes
Aug 12, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 14
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/projects/project-releases.md (1)
1-66: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winResolve the shared formatting failure before merge.
docs/projects/project-releases.md#L1-L66: runpnpm check:formatwithout--checkand commit the formatter output.docs/projects/project-audit-logs.md#L1-L96: apply the same formatter output and rerun CI.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/projects/project-releases.md` around lines 1 - 66, Resolve the shared formatting failure by running pnpm check:format without --check and committing the formatter output for docs/projects/project-releases.md lines 1-66 and docs/projects/project-audit-logs.md lines 1-96, then rerun CI to verify formatting passes.Source: Pipeline failures
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/ai/ai-usage.md`:
- Around line 65-66: Update the Plane Cloud usage description near “Members and
AI agents each have their own allowance” to state that members have per-seat
allowances while AI agents share a separate workspace-level allowance. Keep the
self-hosted deployment description unchanged.
- Line 59: Update the Plane AI credits link in the documentation to use the
canonical /ai/plane-ai-credits route instead of /ai/ai-credits.
- Around line 2-6: Align the AI documentation headings and sidebar labels
exactly: in docs/ai/ai-usage.md lines 2-6, use “AI Usage” consistently in the
front matter title and H1; in docs/.vitepress/config.ts line 744, match that
capitalization; and in docs/ai/plane-ai-credits.md line 6, use “AI credits” or
rename its sidebar label to “Plane AI credits”.
- Around line 50-57: Update the “Your monthly allowance and limits” section to
state that the plan-based allowance and reset behavior apply only to Plane
Cloud. Document both workspace overage states: when enabled, AI continues after
the allowance and usage is billed to the workspace; when disabled, AI features
pause after the allowance is exhausted, while the request crossing the limit
still completes. Preserve the existing warning and meter-overage details where
applicable.
In `@docs/ai/plane-ai-credits.md`:
- Around line 20-30: Reconcile the entitlement descriptions in the AI credits
documentation by confirming the actual product behavior, then update both the AI
credits page and the billing-and-plans page to describe the same canonical
pooling model. Align the member, workspace, seat, reset, and agent-credit
language consistently, removing any contradictory statements while preserving
accurate plan-specific details.
In `@docs/core-concepts/issues/labels.md`:
- Line 44: Update the “suggest labels” link in the work-item documentation to
use the deployed documentation-relative AI label-prediction route instead of the
localhost URL, following the existing convention of omitting .md extensions.
In `@docs/core-concepts/issues/plane-query-language.md`:
- Around line 638-644: Update the work-item action filter documentation around
votedBy, stateChangedBy, and resolvedBy to resolve the user-argument
inconsistency: either narrow the “exactly one user” statement to the history
functions that lack list support, or explicitly document votedBy’s accepted
list-returning people function here, matching the rule described for votedBy
elsewhere.
- Around line 490-495: Add a language identifier, using the repository-supported
pql or text value, to the opening fences for the four PQL examples in the issues
documentation, including the examples around the assignee, 540, 585, and 658
sections. Leave the example contents unchanged.
- Line 548: Update the people-function reference in the paragraph containing
votedBy, commentedBy, attachedBy, and lastCommentBy to link to the documented
User functions anchor (`#user-functions`) instead of the unresolved
`#people-functions` fragment.
In `@docs/core-concepts/pages/editor-blocks.md`:
- Around line 265-290: Align the heading-creation guidance in the table of
contents section with the supported heading range stated in “How it behaves”:
document how users create H4–H6 headings if they are supported, or consistently
change the documented range to H1–H3 throughout the section.
In `@docs/dashboards.md`:
- Line 408: Update the age-band description to use mutually exclusive ranges,
specifically 0–2 days, 3–6 days, and 7+ days, while preserving the existing
scope and fixed-band behavior.
In `@docs/pages/edit-ms-office-files.md`:
- Line 6: Update the page heading in the Markdown document from “Edit Microsoft
Office Files” to “Edit MS Office Files” so it exactly matches the sidebar label
configured in the VitePress configuration.
In `@docs/projects/project-releases.md`:
- Line 8: Update the workspace release links in the project-releases
documentation to use the explicit label “Workspace releases” instead of
“Releases,” including all occurrences referenced by the comment, while leaving
project release wording unchanged.
In `@docs/releases.md`:
- Around line 12-14: Update the comparison in docs/releases.md (lines 12-14) to
state that workspace and project releases also differ in availability,
enablement, entitlement, and permissions, not only scope. Update the
comparison-table introduction in docs/projects/project-releases.md (lines 12-21)
to remove the claim that scope and location are the only differences, while
preserving the documented comparison.
---
Outside diff comments:
In `@docs/projects/project-releases.md`:
- Around line 1-66: Resolve the shared formatting failure by running pnpm
check:format without --check and committing the formatter output for
docs/projects/project-releases.md lines 1-66 and
docs/projects/project-audit-logs.md lines 1-96, then rerun CI to verify
formatting passes.
🪄 Autofix
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 Plus
Run ID: 42c77b35-b4c4-438b-8691-8e147cd709b6
📒 Files selected for processing (12)
docs/.vitepress/config.tsdocs/ai/ai-usage.mddocs/ai/plane-ai-credits.mddocs/core-concepts/issues/labels.mddocs/core-concepts/issues/plane-query-language.mddocs/core-concepts/pages/editor-blocks.mddocs/dashboards.mddocs/pages/edit-ms-office-files.mddocs/projects/project-audit-logs.mddocs/projects/project-releases.mddocs/releases.mddocs/workspaces-and-users/audit-logs.md
Comment on lines
+2
to
+6
| title: AI usage | ||
| description: Monitor how much Plane AI your workspace and its members consume each month, view usage trends and breakdowns, and understand your monthly allowance and limits. | ||
| --- | ||
|
|
||
| # AI usage |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Keep documentation headings and sidebar labels identical.
The changed AI pages use labels that do not exactly match the sidebar entries.
docs/ai/ai-usage.md#L2-L6: useAI Usagefor the front matter and H1, or change the sidebar label.docs/.vitepress/config.ts#L744-L744: use the same capitalization as the AI usage page H1.docs/ai/plane-ai-credits.md#L6-L6: useAI creditsfor the H1, or rename the sidebar label toPlane AI credits.
As per coding guidelines, “Page headings (#) must match the sidebar label defined in docs/.vitepress/config.ts.”
📍 Affects 3 files
docs/ai/ai-usage.md#L2-L6(this comment)docs/.vitepress/config.ts#L744-L744docs/ai/plane-ai-credits.md#L6-L6
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/ai/ai-usage.md` around lines 2 - 6, Align the AI documentation headings
and sidebar labels exactly: in docs/ai/ai-usage.md lines 2-6, use “AI Usage”
consistently in the front matter title and H1; in docs/.vitepress/config.ts line
744, match that capitalization; and in docs/ai/plane-ai-credits.md line 6, use
“AI credits” or rename its sidebar label to “Plane AI credits”.
Source: Coding guidelines
Comment on lines
+50
to
+57
| ## Your monthly allowance and limits | ||
|
|
||
| Each workspace has a monthly AI allowance that depends on your plan. Consumption counts against that allowance during the billing month and resets at the start of the next one. | ||
|
|
||
| - **Nearing your limit.** When you reach about 80% of your allowance, Plane shows a warning so you can plan ahead. | ||
| - **Reaching your limit.** When the allowance is used up, Plane AI features are **paused** for that subject (a member or the workspace's agents) until the next monthly reset. The request that crosses the limit still finishes; the next one is blocked. You will see a message that AI capabilities are temporarily disabled until the reset date. | ||
|
|
||
| Because the limit is applied after a request rather than partway through, your meter can briefly show slightly over 100%. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Scope allowance behavior to Plane Cloud and include workspace overage.
Lines 52-55 describe a plan-based allowance and mandatory pausing for every deployment. docs/ai/plane-ai-credits.md at Lines 12-14 says Plane credits apply only to Plane Cloud. Its Lines 36-41 say enabled workspace overage lets AI continue and bills the workspace. Scope this section to Plane Cloud and document both overage states.
Suggested wording change
-Each workspace has a monthly AI allowance that depends on your plan.
+On Plane Cloud, each workspace has a monthly AI allowance that depends on your plan.
...
-When the allowance is used up, Plane AI features are paused for that subject
+When the allowance is used up and workspace overage is off, Plane AI features are paused for that subject
+When workspace overage is enabled, AI continues and additional usage is billed to the workspace.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/ai/ai-usage.md` around lines 50 - 57, Update the “Your monthly allowance
and limits” section to state that the plan-based allowance and reset behavior
apply only to Plane Cloud. Document both workspace overage states: when enabled,
AI continues after the allowance and usage is billed to the workspace; when
disabled, AI features pause after the allowance is exhausted, while the request
crossing the limit still completes. Preserve the existing warning and
meter-overage details where applicable.
Comment on lines
+65
to
+66
| - **On Plane Cloud**, usage is shown as a **percentage** of a monthly allowance that scales with your plan. Members and AI agents each have their own allowance. | ||
| - **On self-hosted deployments**, you connect your own AI provider, so **members are not metered**. Usage is reported in **tokens**, and only the shared pool used by AI agents is bounded, and only if your administrator has configured a token budget for it. If no agent budget is configured, agent features are unavailable rather than metered. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Describe the agent allowance as workspace-level.
docs/ai/plane-ai-credits.md at Lines 24 and 41 defines one separate workspace-level allowance for AI agents. The phrase “Members and AI agents each have their own allowance” can imply a separate allowance per agent. State that members have per-seat allowances and AI agents use a separate workspace-level allowance.
Suggested wording change
-- **On Plane Cloud**, usage is shown as a **percentage** of a monthly allowance that scales with your plan. Members and AI agents each have their own allowance.
+- **On Plane Cloud**, usage is shown as a **percentage** of a monthly allowance that scales with your plan. Members have per-seat allowances; AI agents use a separate workspace-level allowance.📝 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.
Suggested change
| - **On Plane Cloud**, usage is shown as a **percentage** of a monthly allowance that scales with your plan. Members and AI agents each have their own allowance. | |
| - **On self-hosted deployments**, you connect your own AI provider, so **members are not metered**. Usage is reported in **tokens**, and only the shared pool used by AI agents is bounded, and only if your administrator has configured a token budget for it. If no agent budget is configured, agent features are unavailable rather than metered. | |
| - **On Plane Cloud**, usage is shown as a **percentage** of a monthly allowance that scales with your plan. Members have per-seat allowances; AI agents use a separate workspace-level allowance. | |
| - **On self-hosted deployments**, you connect your own AI provider, so **members are not metered**. Usage is reported in **tokens**, and only the shared pool used by AI agents is bounded, and only if your administrator has configured a token budget for it. If no agent budget is configured, agent features are unavailable rather than metered. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/ai/ai-usage.md` around lines 65 - 66, Update the Plane Cloud usage
description near “Members and AI agents each have their own allowance” to state
that members have per-seat allowances while AI agents share a separate
workspace-level allowance. Keep the self-hosted deployment description
unchanged.
Comment on lines
+20
to
+30
| - Each active paid seat gets a monthly included allowance based on your plan. | ||
| - The allowance is an entitlement tied to seats, so your total capacity scales with your team. | ||
| - Allowances reset at the start of each monthly billing period. | ||
|
|
||
| For current included amounts by plan, check the latest pricing details on [Plane pricing](https://plane.so/pricing#ai-&-credits). | ||
| AI **agents** draw from a separate, workspace-level allowance rather than from any one member's. Automated agent activity does not consume a person's individual credits. | ||
|
|
||
| ## No default pooling | ||
| For current included amounts by plan, see [Plane pricing](https://plane.so/pricing#ai-&-credits). | ||
|
|
||
| Plane AI credits are **not pooled by default**. | ||
| ## Credits are not pooled by default | ||
|
|
||
| That means one member's unused included credits are not automatically shared across the rest of the workspace. | ||
| Each member has their own monthly allowance. One member's unused credits are not automatically shared with the rest of the workspace. This keeps each person's available capacity predictable. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift
🧩 Analysis chain
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
rg -n -C 3 -i \
'ai credits|allowance|pool(ed)?|per[- ]seat|per[- ]member|workspace[- ]level' \
docs --glob '*.md'Repository: makeplane/docs
Length of output: 50370
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
printf '%s\n' '--- docs/ai/plane-ai-credits.md ---'
nl -ba docs/ai/plane-ai-credits.md | sed -n '1,90p'
printf '%s\n' '--- docs/workspaces-and-users/billing-and-plans.md ---'
nl -ba docs/workspaces-and-users/billing-and-plans.md | sed -n '180,196p'
printf '%s\n' '--- AI-credit references ---'
rg -n -C 2 -i 'AI credits|credits per seat|credits.*pool|pool.*credits|individual credits|monthly allowance|top-up|rollover' docs --glob '*.md' \
| head -n 240Repository: makeplane/docs
Length of output: 228
Reconcile the AI credit-pooling model before publishing.
docs/ai/plane-ai-credits.md states that each member has an individual monthly allowance, while docs/workspaces-and-users/billing-and-plans.md states that monthly credits per seat pool at the workspace level. Confirm the product behavior and update both pages to use one canonical entitlement model.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/ai/plane-ai-credits.md` around lines 20 - 30, Reconcile the entitlement
descriptions in the AI credits documentation by confirming the actual product
behavior, then update both the AI credits page and the billing-and-plans page to
describe the same canonical pooling model. Align the member, workspace, seat,
reset, and agent-credit language consistently, removing any contradictory
statements while preserving accurate plan-specific details.
Comment on lines
+265
to
+290
| ## Table of contents <Badge type="tip" text="Business" /> | ||
|
|
||
| On a long page, a table of contents gives readers a quick map of the content and a way to jump straight to any section. Plane builds it from the **headings** in your page, so there is nothing to maintain by hand: as you add, rename, reorder, or remove headings, the table of contents updates on its own. | ||
|
|
||
| The table of contents is available on **pages** and **wiki pages**. It is not available in work item descriptions or comments, which don't track headings. | ||
|
|
||
| A table of contents only shows what it can find, so start by giving your page headings. Type `/` and choose a heading (Heading 1, Heading 2, or Heading 3), or use Markdown shortcuts by starting a line with `#`, `##`, or `###`. Until a page has at least one heading, the table of contents shows an empty message. | ||
|
|
||
| ### Insert a table of contents | ||
|
|
||
| 1. Place your cursor where you want the table of contents, usually near the top of the page. | ||
| 2. Type `/` to open the command menu. | ||
| 3. Search for **Table of contents**. You can also type `/toc`, `/contents`, `/outline`, or `/headings` to find it. | ||
| 4. Select it. Plane inserts the block, described as "a live outline of this page's headings," and adds an empty line after it so you can keep writing. | ||
|
|
||
| The block lists every heading on the page, indented by level so the structure is easy to scan. | ||
|
|
||
| ### How it behaves | ||
|
|
||
| - **Shows every heading level.** Headings from level 1 through level 6 all appear, each indented according to its level. | ||
| - **Stays up to date.** The list rebuilds automatically whenever you add, edit, reorder, or delete a heading. You never edit the table of contents directly. | ||
| - **Jumps to a section.** Click any entry to smoothly scroll the page to that heading. | ||
| - **Handles empty headings.** A heading with no text yet appears as "Untitled heading" until you name it. | ||
|
|
||
| Because it is a normal block, you can drag it to move it elsewhere on the page, or delete it like any other block. | ||
|
|
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Align heading creation instructions with the documented heading range.
Line 271 explains how to create H1-H3 headings, while Line 284 says the table of contents displays H1-H6. If H4-H6 are supported, document how users create them. Otherwise, narrow the supported range to H1-H3.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/core-concepts/pages/editor-blocks.md` around lines 265 - 290, Align the
heading-creation guidance in the table of contents section with the supported
heading range stated in “How it behaves”: document how users create H4–H6
headings if they are supported, or consistently change the documented range to
H1–H3 throughout the section.
|
|
||
| - **Legends** and **Tooltip** - toggle each on or off. | ||
|
|
||
| The widget renders a donut split into three fixed age bands: **0-2 days**, **3-7 days**, and **7+ days**. It covers only undecided items (pending and snoozed); accepted, rejected, and duplicate items are not shown. Each item is aged from its arrival date in intake, and the age bands cannot be changed. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -e
printf '%s\n' '--- target section ---'
sed -n '380,420p' docs/dashboards.md
printf '%s\n' '--- related references ---'
rg -n -i --glob '!node_modules' --glob '!dist' \
'0.?2 days|3.?7 days|3.?6 days|7\+ days|age band|ageing|aging|donut|pending and snoozed|arrival date' .
printf '%s\n' '--- changed-file summary ---'
git diff --stat -- docs/dashboards.md
printf '%s\n' '--- target diff ---'
git diff -- docs/dashboards.md | sed -n '1,240p'Repository: makeplane/docs
Length of output: 12308
🏁 Script executed:
#!/bin/bash
set -e
python3 - <<'PY'
import re
from pathlib import Path
text = Path("docs/dashboards.md").read_text()
line = next(
line for line in text.splitlines()
if "three fixed age bands:" in line
)
labels = re.findall(r"\*\*([^*]+)\*\*", line)
print("labels:", labels)
memberships = {}
for label in labels:
if m := re.fullmatch(r"(\d+)-(\d+) days", label):
lo, hi = map(int, m.groups())
days = set(range(lo, hi + 1))
elif m := re.fullmatch(r"(\d+)\+ days", label):
lo = int(m.group(1))
days = set(range(lo, lo + 10))
else:
raise SystemExit(f"unexpected label: {label!r}")
for day in days:
memberships.setdefault(day, []).append(label)
print("overlapping days:", {
day: bands for day, bands in memberships.items() if len(bands) > 1
})
PYRepository: makeplane/docs
Length of output: 243
Make the ageing bands mutually exclusive.
3–7 days and 7+ days both include day 7. Use 0–2 days, 3–6 days, and 7+ days, or document the actual exclusive boundary rule.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/dashboards.md` at line 408, Update the age-band description to use
mutually exclusive ranges, specifically 0–2 days, 3–6 days, and 7+ days, while
preserving the existing scope and fixed-band behavior.
| description: Edit Word, Excel, and PowerPoint files attached to a wiki page directly in your desktop Microsoft Office app, with changes saved back to Plane. | ||
| --- | ||
|
|
||
| # Edit Microsoft Office Files <Badge type="warning" text="Enterprise Grid" /> |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Match the page heading to the sidebar label.
The sidebar uses Edit MS Office Files, but the page heading uses Edit Microsoft Office Files. Align both labels.
As per coding guidelines, “Page headings (#) must match the sidebar label defined in docs/.vitepress/config.ts.”
Proposed fix
-# Edit Microsoft Office Files <Badge type="warning" text="Enterprise Grid" />
+# Edit MS Office Files <Badge type="warning" text="Enterprise Grid" />📝 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.
Suggested change
| # Edit Microsoft Office Files <Badge type="warning" text="Enterprise Grid" /> | |
| # Edit MS Office Files <Badge type="warning" text="Enterprise Grid" /> |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/pages/edit-ms-office-files.md` at line 6, Update the page heading in the
Markdown document from “Edit Microsoft Office Files” to “Edit MS Office Files”
so it exactly matches the sidebar label configured in the VitePress
configuration.
Source: Coding guidelines
Comment on lines
+12
to
+14
| These workspace releases live at the workspace level, so a single release can pull in work items from multiple projects. A release for "v2.3.0" might include a backend fix from your API project, a UI change from your web project, and a docs update from your content project, all tracked together in one place. | ||
|
|
||
| Plane also offers **project releases**, a version of the same feature scoped to a single project and enabled per project. If you want to group and ship one project's work on its own, see [Project releases](/projects/project-releases). Everything on this page about creating, scoping, and shipping a release applies to both; the difference is only their scope. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Keep release-scope comparisons consistent.
Both pages describe scope as the only difference, but docs/projects/project-releases.md also documents separate enablement, entitlement, and permission behavior.
docs/releases.md#L12-L14: revise the workspace-versus-project comparison to include availability and permissions.docs/projects/project-releases.md#L12-L21: revise the comparison table introduction so it does not say that scope and location are the only differences.
📍 Affects 2 files
docs/releases.md#L12-L14(this comment)docs/projects/project-releases.md#L12-L21
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/releases.md` around lines 12 - 14, Update the comparison in
docs/releases.md (lines 12-14) to state that workspace and project releases also
differ in availability, enablement, entitlement, and permissions, not only
scope. Update the comparison-table introduction in
docs/projects/project-releases.md (lines 12-21) to remove the claim that scope
and location are the only differences, while preserving the documented
comparison.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit