Milestones, Auto-schedule cycles, Custom exports #363
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis PR updates documentation terminology from "issue" to "work item" across many docs, adds a new Milestones doc and sidebar entry, introduces Draw.io diagram/board docs in editor blocks, expands export docs with a "Custom exports" section and guide, and adds an Auto-schedule cycles section to cycles documentation. Changes
Sequence Diagram(s)sequenceDiagram
rect rgba(46,125,50,0.06)
participant User
participant UI
participant Scheduler
participant DB
end
User->>UI: Configure Auto-schedule (title, duration, cooldown, start day, future count, auto-rollover)
UI->>Scheduler: Submit schedule configuration
Scheduler->>DB: Save config
DB-->>Scheduler: Ack
Scheduler->>Scheduler: Validate non-overlap & compute future cycles
alt success
Scheduler->>DB: Create future cycle records
DB-->>Scheduler: Created
Scheduler->>UI: Show scheduled cycles
else conflict/error
Scheduler->>UI: Return validation error
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ 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: 7
🧹 Nitpick comments (1)
docs/core-concepts/pages/overview.mdx (1)
107-107: Capitalize "page" for consistency with "Project".The section mixes capitalization styles. Consider whether both should be capitalized for consistency.
-Transfer a page to Wiki, Teamspace or a different Project in your workspace. +Transfer a Page to Wiki, Teamspace or a different Project in your workspace.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
docs/ai/pi-chat.mdx(2 hunks)docs/automations/custom-automations.mdx(3 hunks)docs/core-concepts/cycles.mdx(1 hunks)docs/core-concepts/deploy.mdx(3 hunks)docs/core-concepts/export.mdx(3 hunks)docs/core-concepts/pages/editor-blocks.mdx(1 hunks)docs/core-concepts/pages/inline-comments.mdx(2 hunks)docs/core-concepts/pages/overview.mdx(1 hunks)docs/core-concepts/projects/milestones.mdx(1 hunks)docs/importers/asana.mdx(1 hunks)docs/integrations/slack.mdx(3 hunks)docs/introduction/tutorials/invite-members.mdx(1 hunks)sidebars.ts(1 hunks)
🔇 Additional comments (10)
docs/importers/asana.mdx (1)
88-88: LGTM!Terminology update correctly applied and consistent with the PR's work item terminology shift.
docs/introduction/tutorials/invite-members.mdx (1)
60-60: LGTM!Terminology update is clear and maintains role description accuracy.
docs/core-concepts/deploy.mdx (1)
32-32: LGTM!Terminology updates correctly applied across visible attributes, links, and reactions sections. All changes maintain clarity and accuracy.
Also applies to: 43-43, 58-58
docs/automations/custom-automations.mdx (1)
4-4: LGTM!Terminology updates consistently applied throughout the automations documentation. All examples remain clear and relevant with the new work item terminology.
Also applies to: 16-16, 107-107, 110-110, 113-113
docs/core-concepts/pages/editor-blocks.mdx (1)
114-137: New Draw.io section is well-structured and clearly documented.The section appropriately documents diagram and board features with relevant slash commands and usage guidance. Pricing tier tag placement is consistent with other pro/business features.
docs/core-concepts/cycles.mdx (1)
96-130: New Auto-schedule cycles section is well-documented and comprehensive.The benefits and configuration steps are clearly laid out with helpful detail. The section fits well into the cycles documentation and appropriately marks the Business pricing tier.
docs/core-concepts/export.mdx (1)
54-81: Well-structured documentation addition.The custom exports section provides clear, actionable guidance with appropriate formatting and visual references. The step-by-step instructions and list of exportable data types enhance user understanding.
docs/integrations/slack.mdx (1)
95-96: Terminology updates are consistent and correct.The updates from "issue" to "work item" throughout the Slack integration documentation maintain consistency with the broader documentation terminology changes.
Also applies to: 119-121, 164-164
sidebars.ts (1)
156-156: LGTM: Sidebar entry correctly added.The new milestones entry is appropriately placed in the "Planning and organization" category and corresponds to the new documentation page.
docs/core-concepts/projects/milestones.mdx (1)
1-71: Excellent documentation for the new Milestones feature.This documentation provides comprehensive coverage of the Milestones feature with:
- Clear setup instructions for enabling the feature
- Step-by-step guidance for creating and managing milestones
- Multiple approaches for linking work items
- Visual aids throughout
- Appropriate use of the Tags component to indicate Pro plan requirement
The structure, tone, and formatting are consistent with the rest of the documentation.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/core-concepts/cycles.mdx (1)
120-120: Terminology consistency already applied. This line correctly uses "incomplete work items" (not "incomplete issues"), addressing the prior review feedback. No further action needed.
🧹 Nitpick comments (2)
docs/core-concepts/cycles.mdx (2)
10-10: Minor: Consider replacing "where" with "when" for grammatical precision.The phrase "a set period of time where your team focuses" is clear and conversational, but could be tightened grammatically to "a set period of time when your team focuses" for better adherence to formal writing conventions. This is a polish-level refinement.
152-152: Optional: Vary word choice for "giving." The phrase "giving you the flexibility" is clear but somewhat standard. Consider "allowing you the flexibility" or "enabling you to" for subtle variety. This is a stylistic preference.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/core-concepts/cycles.mdx(4 hunks)docs/core-concepts/export.mdx(3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/core-concepts/cycles.mdx
[style] ~10-~10: It might be better to use ‘time’ with the time-relative pronoun ‘when’. (Alternatively, use ‘in/on which’.)
Context: ...sing Cycles A Cycle is a set period of time where your team focuses on completing specifi...
(WHEN_WHERE)
[style] ~152-~152: Consider replacing ‘giving’ with a different word to let your writing stand out.
Context: ...* or point estimates for each task, giving you the flexibility to use the metrics that...
(GIVE_TIME_STYLE)
🔇 Additional comments (5)
docs/core-concepts/cycles.mdx (1)
96-130: Well-structured Auto-schedule cycles section. The new documentation clearly explains benefits, configuration steps, and automated behavior. The terminology is consistent with the PR's "work items" standardization, and the Business tier tag is properly applied.docs/core-concepts/export.mdx (4)
6-6: Import statement is properly scoped.The Tags component import from
@site/src/components/Tagsis correctly placed at the module level for MDX usage.
59-66: Terminology update correctly addresses past review concern.Line 63 uses "Export filtered work item lists from any view" rather than the previously flagged "issue lists," confirming that the terminology standardization from "issue" to "work item" has been applied consistently in this new section.
16-16: Documentation structure and instructions are clear and well-organized.The reorganization into "Export projects" (workspace-level admin operations) and "Custom exports" (project-level user operations) provides a logical flow. The step-by-step instructions with UI element references (e.g., "⋯ (more options) menu") are clear and actionable. The Custom exports section appropriately emphasizes that exported data reflects current filters and display options, which manages user expectations.
Also applies to: 68-80
54-57: Tags component structure and props verified—no issues found.The Tags component accepts the exact prop structure being used in export.mdx (lines 54-57). Each tag object with
name,link, andadditionalClassmatches the component's interface. The.tag-wrapperCSS class is properly defined insrc/css/custom.csswith appropriate flexbox styling.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Adds docs for Milestones, Auto-schedule Cycles, Custom Exports, and Draw.io diagrams, and updates terminology to “work item” across multiple docs with a sidebar entry for Milestones.
core-concepts/projects/milestones.mdxwith setup, linking items/epics, and management; added tosidebars.ts.core-concepts/cycles.mdx.core-concepts/export.mdx.core-concepts/pages/editor-blocks.mdx.work itemacross AI chat, Automations, Cycles charts/metrics, Deploy (IDs, links, reactions), Export headings, Inline Comments, Asana importer mapping table, Slack integration, Invite Members (role capabilities).Written by Cursor Bugbot for commit 7817e54. This will update automatically on new commits. Configure here.
Summary by CodeRabbit