Skip to content

Custom relations#423

Open
danciaclara wants to merge 4 commits intomasterfrom
custom-relations
Open

Custom relations#423
danciaclara wants to merge 4 commits intomasterfrom
custom-relations

Conversation

@danciaclara
Copy link
Copy Markdown
Collaborator

@danciaclara danciaclara commented Mar 31, 2026

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Added a new "Custom Relations" docs page with step‑by‑step workspace admin instructions for creating, editing, and deleting custom relation types
    • Added a sidebar link to "Custom Relations" under Advanced management
    • Clarified difference between scheduling "Dependencies" (use Add dependency) and non‑scheduling "Relations" (use Add relation)
    • Updated timeline dependency guidance and related navigation for clarity

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 31, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 16d5e129-3f28-4c05-ac64-a033c70b9702

📥 Commits

Reviewing files that changed from the base of the PR and between 77a888c and 6813a19.

📒 Files selected for processing (1)
  • docs/core-concepts/issues/overview.md
✅ Files skipped from review due to trivial changes (1)
  • docs/core-concepts/issues/overview.md

📝 Walkthrough

Walkthrough

Added documentation for workspace-level custom relation types and reorganized relation/dependency docs to distinguish scheduling dependencies from non-scheduling relations. A sidebar entry was added for the new custom relations page.

Changes

Cohort / File(s) Summary
Navigation
docs/.vitepress/config.ts
Added a sidebar item linking to the new custom relations doc.
New docs
docs/advanced-management/custom-relations.md
New page describing how workspace admins create, edit, and delete custom relation types, required fields (Title, Inward name, Outward name), workspace-wide availability, and how relations appear when linking work items.
Concepts — Relations vs Dependencies
docs/core-concepts/issues/overview.md, docs/core-concepts/issues/timeline-dependency.md
Rewrote relation content to separate scheduling dependencies (via "Add dependency" with types like Blocked by/Blocking/Starts Before/After/Finishes Before/After) from non-scheduling relations (Relates To, Duplicate, Implements, Implemented By). Updated timeline dependency guidance to reference the new Add dependency flow and removed the prior dependency-relation screenshot.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 I hopped through docs with ink so bright,

I drew new links that feel just right,
Dependencies march upon the time,
Relations whisper, gentle, kind,
Admin carrots earned—what a delight!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Custom relations' directly matches the main feature introduced in this pull request, which adds a new documentation page for custom relations and updates related documentation sections.
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 custom-relations

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.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 31, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 31, 2026 1:12pm

Request Review

Copy link
Copy Markdown

@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.

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/advanced-management/custom-relations.md`:
- Line 10: The sentence in docs/advanced-management/custom-relations.md
incorrectly states "three [default relation types]"; update that phrase to "four
[default relation types]" to match the linked core-concepts list (Relates To,
Duplicate, Implements, Implemented By) so the count in the paragraph containing
"Plane includes three [default relation types]" is correct.

In `@docs/core-concepts/issues/overview.md`:
- Around line 64-76: The link in the docs text "Timeline layout" points to the
wrong path (/core-concepts/issues/timeline-dependencies); update that markdown
link in docs/core-concepts/issues/overview.md to the correct target
(/core-concepts/issues/timeline-dependency or the exact filename
timeline-dependency.md) so the VitePress build can resolve the page; search for
the anchor text "Timeline layout" or the link string "timeline-dependencies" and
replace it with the singular "timeline-dependency" reference.
🪄 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: 73743abf-6500-43c9-b580-c1caff3700c8

📥 Commits

Reviewing files that changed from the base of the PR and between 9e68318 and 77a888c.

📒 Files selected for processing (4)
  • docs/.vitepress/config.ts
  • docs/advanced-management/custom-relations.md
  • docs/core-concepts/issues/overview.md
  • docs/core-concepts/issues/timeline-dependency.md


Relations describe how work items are connected to each other.

Plane includes three [default relation types](/core-concepts/issues/overview#add-relations) that cover common use cases. You can create additional relation types tailored to how your organization thinks about work. For example, a team might define a "Tests" relation so QA work items link back to the features they validate, or a "Depends On" relation to model logical dependencies that don't map to scheduling constraints.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Correct the count of default relation types.

The text claims "three [default relation types]" but according to the linked documentation in docs/core-concepts/issues/overview.md (lines 77-85), there are actually four default relation types:

  1. Relates To
  2. Duplicate
  3. Implements
  4. Implemented By
📝 Proposed fix
-Plane includes three [default relation types](/core-concepts/issues/overview#add-relations) that cover common use cases. You can create additional relation types tailored to how your organization thinks about work. For example, a team might define a "Tests" relation so QA work items link back to the features they validate, or a "Depends On" relation to model logical dependencies that don't map to scheduling constraints.
+Plane includes four [default relation types](/core-concepts/issues/overview#add-relations) that cover common use cases. You can create additional relation types tailored to how your organization thinks about work. For example, a team might define a "Tests" relation so QA work items link back to the features they validate, or a "Depends On" relation to model logical dependencies that don't map to scheduling constraints.
📝 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
Plane includes three [default relation types](/core-concepts/issues/overview#add-relations) that cover common use cases. You can create additional relation types tailored to how your organization thinks about work. For example, a team might define a "Tests" relation so QA work items link back to the features they validate, or a "Depends On" relation to model logical dependencies that don't map to scheduling constraints.
Plane includes four [default relation types](/core-concepts/issues/overview#add-relations) that cover common use cases. You can create additional relation types tailored to how your organization thinks about work. For example, a team might define a "Tests" relation so QA work items link back to the features they validate, or a "Depends On" relation to model logical dependencies that don't map to scheduling constraints.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/advanced-management/custom-relations.md` at line 10, The sentence in
docs/advanced-management/custom-relations.md incorrectly states "three [default
relation types]"; update that phrase to "four [default relation types]" to match
the linked core-concepts list (Relates To, Duplicate, Implements, Implemented
By) so the count in the paragraph containing "Plane includes three [default
relation types]" is correct.

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.

1 participant