Add documentation for creating work items via URL

[Prashant-Surya]

Summary

This PR adds comprehensive documentation for the work item URL creation feature, which allows users to create new work items in Plane by visiting a special URL with pre-filled fields via query parameters.

Changes

• New documentation file: docs/core-concepts/issues/work-item-url.mdx

  • Explains the base URL structure for creating work items
  • Documents all supported query parameters: workspace, title, description, project, priority, assignee, start_date, and due_date
  • Provides detailed examples for each parameter with various use cases
  • Includes combined examples showing how to use multiple parameters together
  • Lists important notes about authentication, case-sensitivity, and parameter validation

• Updated sidebar navigation: sidebars.ts

  • Added the new documentation page to the "Issues" section under "Core Concepts"

Key Features Documented

• URL-based work item creation with automatic modal opening
• Support for pre-filling multiple work item fields
• Flexible assignee assignment (by UUID, display name, or "me")
• Multiple date format support for start and due dates
• Project selection by identifier or UUID
• Priority levels with case-insensitive matching
• Multi-user assignment capability

Notes

• Documentation includes clear examples for each parameter
• Covers edge cases like URL encoding for spaces and special characters
• Explains authentication requirements and fallback behavior

https://claude.ai/code/session_01NTCkVk8Kkqiesh3SksMhEu

Summary by CodeRabbit

• Documentation
  • Added a new guide explaining how to create and pre-fill work items via URL query parameters (workspace, title, description, project, priority, assignee, start_date, due_date), including encoding rules, handling multiple parameters/values, examples from simple to fully populated items, and notes on case sensitivity and validation.
  • Updated navigation to surface the new work item URL guide for easier discovery.

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
docs	Ready	Preview, Comment	Feb 5, 2026 9:16am
docs-vitepress	Error		Feb 5, 2026 9:16am

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a new documentation page explaining how to create and pre-fill work items via URL query parameters and updates the tutorial sidebar to include the new page under Work Items.

Changes

Cohort / File(s)	Summary
Documentation Addition docs/core-concepts/issues/work-item-url.mdx	New documentation page covering base URLs (cloud and self‑hosted), authentication behavior, URL construction rules and encoding, supported query parameters (workspace, title, description, project, priority, assignee, start_date, due_date), examples, combined usage scenarios, and notes on case sensitivity, unknown values, and editability after fill.
Sidebar Update sidebars.ts	Added "core-concepts/issues/work-item-url" to the Work Items list in the tutorial sidebar.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I nibble query keys beneath the moon,
Tail twitching as fields fill in tune,
Titles, dates, and people in a hop—
A pre-made task, ready to stop,
Click the sidebar and let the forms bloom.

🚥 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 accurately summarizes the main change: adding documentation for the work-item-url feature that enables creating work items via URL.
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 docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch claude/add-work-item-url-page-Cni1p

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/core-concepts/issues/work-item-url.mdx`:
- Around line 16-20: Update the first bullet so the redirect behavior is
conditional: state that if a workspace query parameter (`workspace`) is provided
the user will be redirected to that specified workspace, otherwise they will be
redirected to their last active workspace; adjust the wording in the other
occurrence (lines 34–38) to match this conditional behavior and ensure the
`workspace` parameter section explicitly says it overrides the default
last-active redirect.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/core-concepts/issues/work-item-url.mdx`:
- Around line 136-137: Replace the vague claim "Accepts any valid date format
that JavaScript `Date` can parse" with a clearer recommendation to use
unambiguous ISO formats only; update the second line that currently reads
"Recommended formats: `YYYY-MM-DD` or ISO 8601" to explicitly require ISO 8601
(e.g., "Recommended format: ISO 8601 (YYYY-MM-DD or full ISO with time and
timezone)") and remove implication that locale-dependent or ambiguous formats
like `MM/DD/YYYY` are acceptable so readers know to avoid them.

🧹 Nitpick comments (1)

docs/core-concepts/issues/work-item-url.mdx (1)

79-92: Add case-sensitivity note to project section for consistency.

The Notes section (line 180) mentions project identifiers are case-insensitive, but this section doesn't state that explicitly. Consider adding a bullet point for consistency with the priority section.

📝 Suggested addition

 - Can be set by project **identifier** (e.g., `PROJ`, `WEB`)
 - Can be set by project **UUID**
+- Case-insensitive for project identifiers