Add documentation for creating work items via URL#397
Add documentation for creating work items via URL#397Prashant-Surya wants to merge 4 commits intomasterfrom
Conversation
Adds a new page under Work Items that documents the /work-items/new URL endpoint for creating work items with pre-filled fields using query parameters. Covers all supported parameters including workspace, title, description, project, priority, assignee, start_date, and due_date. https://claude.ai/code/session_01NTCkVk8Kkqiesh3SksMhEu
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughAdds a new documentation page describing how to create and pre-fill work items via a URL with query parameters, and updates the tutorial sidebar to include the new page under Work Items. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 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.
Use app.plane.so as the base URL and add a tip callout for self-hosted users to replace it with their own domain. https://claude.ai/code/session_01NTCkVk8Kkqiesh3SksMhEu
There was a problem hiding this comment.
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
Use inline code formatting for URLs and parameter values, add a summary table for query parameters, and use bold-label bullet lists for combined examples to match the style of other docs pages. https://claude.ai/code/session_01NTCkVk8Kkqiesh3SksMhEu
URLs are now shown as readable plain text in the flow of paragraphs, matching the style used by Linear's docs. Parameter descriptions use bold and prose instead of code formatting. https://claude.ai/code/session_01NTCkVk8Kkqiesh3SksMhEu
2 participants
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.mdxworkspace,title,description,project,priority,assignee,start_date, anddue_dateUpdated sidebar navigation:
sidebars.tsKey Features Documented
Notes
https://claude.ai/code/session_01NTCkVk8Kkqiesh3SksMhEu
Summary by CodeRabbit