Rich filters #353
Rich filters #353
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Caution Review failedThe pull request is closed. WalkthroughUpdated documentation: one page title changed, one filters doc fully rewritten and expanded with operator references and examples, and the documentation sidebar flattened by removing a nested "Layouts" category and promoting three pages to top-level items. No application code or exported API changes. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsSite as Docs Site (Sidebar)
rect rgba(135,206,235,0.12)
Note over DocsSite: Sidebar structure updated (flattened Visualization)
end
User->>DocsSite: Open "Visualization" section
DocsSite-->>User: Present top-level entries:
Note right of DocsSite: - layouts<br/>- visualise_filter<br/>- display-options
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
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: 0
🧹 Nitpick comments (7)
docs/core-concepts/issues/display-options.mdx (2)
19-27: Normalize property names to match UI and internal consistency.Minor casing/terminology fixes; align with “Start date/Target date” used elsewhere.
Apply this diff:
- - Work item Type + - Type - - Start Date + - Start date - - Due Date + - Target date - - Sub-work item Count + - Sub-work item count - - Attachment Count + - Attachment count
33-56: Hyphenation/case nits (“Subgroup”, “Created by”).Keep terminology consistent across docs.
Apply this diff:
-## Sub-group by +## Subgroup by @@ -You can further refine your view by adding a sub-grouping. +You can further refine your view by adding a subgrouping. @@ -- Created By +- Created by @@ -- Created By +- Created bydocs/core-concepts/issues/visualise_filter.mdx (5)
33-36: Example uses “in” operator; reconcile with Operator availability section.Either the “in” operator is supported (then reflect that in the Operator availability box), or update the example to avoid “in”.
41-44: Small correctness nits in the example (“empty” token and “Todo” spelling).Apply this diff:
-**Review items without assignments:** -- Set **Assignee** → is → [empty] -- Add State → in → [Backlog, To Do] +**Review items without assignments:** +- Set **Assignee** → **is** → `No assignee` +- Add **State** → **in** → [`Backlog`, `Todo`]
49-55: Clarify relative dates and use conventional operator names.Avoid weekday ambiguity; prefer “start/end of this week”. Use “on or after/before”.
Apply this diff:
-**This week's deliverables:** -- Set **Target date** → **between** → [Monday] and [Sunday] +**This week's deliverables:** +- Set **Target date** → **between** → [Start of this week] and [End of this week] @@ -**Items starting soon:** -- Set **Start Date** → **after or on** → [Today] -- Add **Start Date** → **before or on** → [One week from today] +**Items starting soon:** +- Set **Start date** → **on or after** → [Today] +- Add **Start date** → **on or before** → [One week from today]
75-81: Admonition syntax and forward‑looking statement.Docusaurus admonitions typically use “:::info Title”. Also avoid promising future operators unless certain.
Apply this diff:
-:::info[Operator availability] +:::info Operator availability @@ -**Paid plans** -Unlock advanced filtering with additional operators including `is not`, `after`, `before`, and more specialized conditions. We will be adding more conditions here such as `in`, `contains`, `is empty`, etc. . +**Paid plans** +Unlock advanced filtering with additional operators such as `is not`, `after`, and `before`. Availability can vary by plan. :::
167-179: Date operator list: simplify to commonly used, user‑friendly names.Reduce cognitive load and match typical UI labels.
Apply this diff:
-| `before` | Earlier than this date | Due before Monday | -| `not before` | This date or later | Not due before Monday (due Monday or later) | -| `before or on` | This date or earlier | Due Monday or earlier | -| `not before or on` | Later than this date | Not due Monday or earlier (due after Monday) | -| `after` | Later than this date | Due after Friday | -| `not after` | This date or earlier | Not due after Friday (due Friday or earlier) | -| `after or on` | This date or later | Due Friday or later | -| `not after or on` | Earlier than this date | Not due Friday or later (due before Friday) | +| `before` | Earlier than this date | Due before Monday | +| `on or before` | This date or earlier | Due Monday or earlier | +| `after` | Later than this date | Due after Friday | +| `on or after` | This date or later | Due Friday or later | | `between` | Within date range | Due this week | | `not between` | Outside date range | Not due this week |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/core-concepts/issues/display-options.mdx(1 hunks)docs/core-concepts/issues/visualise_filter.mdx(1 hunks)sidebars.ts(1 hunks)
🔇 Additional comments (5)
docs/core-concepts/issues/display-options.mdx (2)
2-2: Title change looks good.Renaming to “Display options” aligns with the page content and sidebar entry.
61-67: Verify “Order by” labels match the product UI.Confirm exact label strings (e.g., “Last updated” vs “Last Updated”; “Recently created” vs “Last Created”) to avoid user confusion.
docs/core-concepts/issues/visualise_filter.mdx (2)
2-2: Retitle to “Work item filters” is on point.Matches the broadened scope beyond visuals.
100-108: “State Group” terminology: confirm group names.Text mentions “active/backlog” but the example uses “Started”. Verify the canonical group labels in UI (Backlog, Active/Started, Completed) and align both lines accordingly.
sidebars.ts (1)
80-82: Approve: visualization docs present and verifiedPromoting layouts / visualise_filter / display-options under Visualization looks correct — good flattening and sensible order. Verified files: docs/core-concepts/issues/layouts.mdx, docs/core-concepts/issues/visualise_filter.mdx, docs/core-concepts/issues/display-options.mdx.
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit