Skip to content

Multiple updates in docs#418

Merged
sriramveeraghanta merged 2 commits intomasterfrom
updates-20-03-26
Mar 20, 2026
Merged

Multiple updates in docs#418
sriramveeraghanta merged 2 commits intomasterfrom
updates-20-03-26

Conversation

@danciaclara
Copy link
Collaborator

@danciaclara danciaclara commented Mar 20, 2026

Release Notes

  • Documentation
    • Documented copy branch name feature from work item header toolbar
    • Documented time log editing and deletion workflow
    • Documented ability to leave a project and workspace
    • Documented private views feature (Pro-only) for workspace and project views
    • Clarified milestone visualization in Timeline layout

Summary by CodeRabbit

  • Documentation
    • Added documentation for the branch name copying feature in work items.
    • Documented workflows for editing and deleting time logs.
    • Added instructions for leaving projects and workspaces.
    • Updated documentation on milestone timeline layout and view types.
    • Documented the new private views feature for Pro plans.

@vercel
Copy link

vercel bot commented Mar 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 20, 2026 3:58pm

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

Updates to product documentation: added instructions for copying branch names and editing/deleting time logs; restructured project membership content and added leave-project/workspace steps; clarified views behavior and introduced a Private views section; small formatting fix to a billing heading.

Changes

Cohort / File(s) Summary
Issues Documentation
docs/core-concepts/issues/overview.md, docs/core-concepts/issues/time-tracking.md
Added "Copy branch name" section to overview and an "Edit or delete a time log" section to time-tracking with UI steps and examples.
Project Membership & Milestones
docs/core-concepts/projects/manage-project-members.md, docs/core-concepts/projects/milestones.md
Moved "How users join projects" below a new "Leave a project" section; consolidated milestone Timeline description and removed redundant bullets.
Views & Workspace Members
docs/core-concepts/views.md, docs/core-concepts/workspaces/members.md
Clarified workspace vs. project view availability and layouts; replaced "Investigating with Views" with a "Private views" Pro-only section; added "Leave a workspace" instructions.
Billing
docs/workspaces-and-users/billing-and-plans.md
Minor heading punctuation change: removed trailing question mark for consistency.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I copy the branch with a nimble hop,
I edit time logs — not a single flop,
Views tuck themselves behind a tiny lock,
I leave and return with a gentle knock,
Docs tidy, I nibble a carrot — hop!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Multiple updates in docs' is generic and vague, using a non-descriptive term that doesn't convey meaningful information about the specific changes. Replace with a more descriptive title highlighting the main feature additions, such as 'Document copy branch name, time tracking, leave actions, and private views features' or summarize the primary change if one dominates.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch updates-20-03-26

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)
docs/core-concepts/projects/manage-project-members.md (1)

1-1: ⚠️ Potential issue | 🔴 Critical

Fix formatting issues flagged by oxfmt.

The CI pipeline runs oxfmt --check as part of the formatting check. Run pnpm fix:format to automatically fix formatting issues in all files, or oxfmt --write docs/core-concepts/projects/manage-project-members.md to fix this file specifically.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/core-concepts/projects/manage-project-members.md` at line 1, Run the
formatter to fix Oxfmt formatting errors in the markdown: execute pnpm
fix:format to fix all files or run oxfmt --write
docs/core-concepts/projects/manage-project-members.md to rewrite this specific
file (manage-project-members.md) so it passes the CI oxfmt --check step.
docs/workspaces-and-users/billing-and-plans.md (1)

1-1: ⚠️ Potential issue | 🔴 Critical

Fix trailing whitespace and formatting issues detected by oxfmt.

The file has trailing whitespace on multiple lines (117, 159, 205, 208, 211, and others) along with potential character encoding issues. Run pnpm fix:format or oxfmt --write docs/workspaces-and-users/billing-and-plans.md to automatically resolve these formatting violations.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/workspaces-and-users/billing-and-plans.md` at line 1, Remove trailing
whitespace and fix encoding/formatting issues in the billing-and-plans markdown
(docs/workspaces-and-users/billing-and-plans.md) by running the repository
formatter; run "pnpm fix:format" or "oxfmt --write
docs/workspaces-and-users/billing-and-plans.md" to automatically trim trailing
spaces and correct character encoding, then re-check the lines mentioned (around
lines 117, 159, 205, 208, 211) to confirm no remaining trailing whitespace or
stray characters.
docs/core-concepts/projects/milestones.md (1)

1-1: ⚠️ Potential issue | 🔴 Critical

Fix formatting issues flagged by oxfmt.

The CI pipeline reports that oxfmt check failed: formatting issues found. Run oxfmt without the --check flag to automatically fix formatting issues in this file.

#!/bin/bash
# Run oxfmt to check and display formatting issues
oxfmt --check docs/core-concepts/projects/milestones.md
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/core-concepts/projects/milestones.md` at line 1, The file
docs/core-concepts/projects/milestones.md failed oxfmt check; run oxfmt on that
file (without --check) to auto-fix formatting, review the changed
whitespace/formatting, and commit the updated file so CI passes (e.g., run
`oxfmt docs/core-concepts/projects/milestones.md`, verify, then git add/commit).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@docs/core-concepts/projects/manage-project-members.md`:
- Line 1: Run the formatter to fix Oxfmt formatting errors in the markdown:
execute pnpm fix:format to fix all files or run oxfmt --write
docs/core-concepts/projects/manage-project-members.md to rewrite this specific
file (manage-project-members.md) so it passes the CI oxfmt --check step.

In `@docs/core-concepts/projects/milestones.md`:
- Line 1: The file docs/core-concepts/projects/milestones.md failed oxfmt check;
run oxfmt on that file (without --check) to auto-fix formatting, review the
changed whitespace/formatting, and commit the updated file so CI passes (e.g.,
run `oxfmt docs/core-concepts/projects/milestones.md`, verify, then git
add/commit).

In `@docs/workspaces-and-users/billing-and-plans.md`:
- Line 1: Remove trailing whitespace and fix encoding/formatting issues in the
billing-and-plans markdown (docs/workspaces-and-users/billing-and-plans.md) by
running the repository formatter; run "pnpm fix:format" or "oxfmt --write
docs/workspaces-and-users/billing-and-plans.md" to automatically trim trailing
spaces and correct character encoding, then re-check the lines mentioned (around
lines 117, 159, 205, 208, 211) to confirm no remaining trailing whitespace or
stray characters.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 152d7d22-8c72-4ed2-93f0-125c76f0fc7d

📥 Commits

Reviewing files that changed from the base of the PR and between d28b835 and 5718730.

📒 Files selected for processing (7)
  • docs/core-concepts/issues/overview.md
  • docs/core-concepts/issues/time-tracking.md
  • docs/core-concepts/projects/manage-project-members.md
  • docs/core-concepts/projects/milestones.md
  • docs/core-concepts/views.md
  • docs/core-concepts/workspaces/members.md
  • docs/workspaces-and-users/billing-and-plans.md

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/core-concepts/workspaces/members.md (1)

131-134: Reformat to match the document's numbered-step pattern.

The other procedural sections in this document (inviting members, importing CSV, changing roles, removing members) all use numbered steps. For consistency and improved readability, this section should follow the same format.

📝 Suggested formatting to match document style
 ## Leave a workspace
 
-If you no longer need access to a workspace, you can leave it yourself. Click the … menu next to your own name in Workspace Settings > Members and select **Leave**.
-You'll lose access to the workspace and all its projects immediately. If you need to rejoin later, a Workspace Admin will need to invite you again.
+If you no longer need access to a workspace, you can leave it yourself.
+
+1. Navigate to **Workspace settings > Members**.
+2. Click the **…** menu next to your own name.
+3. Select **Leave**.
+4. Confirm you want to leave.
+
+You'll lose access to the workspace and all its projects immediately. If you need to rejoin later, a Workspace Admin will need to invite you again.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/core-concepts/workspaces/members.md` around lines 131 - 134, Reformat
the "Leave a workspace" section to match the document's numbered-step pattern:
convert the current two-paragraph prose under the "## Leave a workspace" heading
into a short ordered list of steps (e.g., 1. Open Workspace Settings > Members;
2. Click the … menu next to your name; 3. Select **Leave**), followed by a final
numbered note about immediate loss of access and rejoin requiring a Workspace
Admin. Ensure the heading text "Leave a workspace" remains unchanged and keep
the wording consistent with other procedural sections (use numbered steps and
bold UI labels).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/core-concepts/workspaces/members.md`:
- Around line 131-134: Reformat the "Leave a workspace" section to match the
document's numbered-step pattern: convert the current two-paragraph prose under
the "## Leave a workspace" heading into a short ordered list of steps (e.g., 1.
Open Workspace Settings > Members; 2. Click the … menu next to your name; 3.
Select **Leave**), followed by a final numbered note about immediate loss of
access and rejoin requiring a Workspace Admin. Ensure the heading text "Leave a
workspace" remains unchanged and keep the wording consistent with other
procedural sections (use numbered steps and bold UI labels).

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d959eeae-3171-4d1a-8a22-3c18e83ac929

📥 Commits

Reviewing files that changed from the base of the PR and between 5718730 and 890543b.

📒 Files selected for processing (5)
  • docs/core-concepts/issues/overview.md
  • docs/core-concepts/issues/time-tracking.md
  • docs/core-concepts/projects/manage-project-members.md
  • docs/core-concepts/views.md
  • docs/core-concepts/workspaces/members.md
✅ Files skipped from review due to trivial changes (2)
  • docs/core-concepts/issues/overview.md
  • docs/core-concepts/issues/time-tracking.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/core-concepts/views.md
  • docs/core-concepts/projects/manage-project-members.md

@sriramveeraghanta sriramveeraghanta merged commit 42285df into master Mar 20, 2026
5 checks passed
@sriramveeraghanta sriramveeraghanta deleted the updates-20-03-26 branch March 20, 2026 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants