Skip to content

docs(TSP-1231): add Errors tab and interactive timeline chart documentation#611

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1231
Open

docs(TSP-1231): add Errors tab and interactive timeline chart documentation#611
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1231

Conversation

@claude
Copy link
Copy Markdown

@claude claude Bot commented May 12, 2026

Summary

  • Adds Errors tab to the tab list in the task list sidebar section
  • Documents the new interactive 7-day error timeline chart: clicking a bar filters the task list to that day's errors, with red highlighting on the selected bar
  • Explains how to clear the date filter via the filter indicator or standard filter controls
  • Fixes heading capitalization to sentence case throughout the page (per docs standards)

Linear issue

https://linear.app/relevance/issue/TSP-1231/

Test plan

  • Verify Errors tab description is accurate against the feature implementation
  • Check that the taskops-milestone-2-fe feature flag context is understood (feature may not be visible without the flag)
  • Confirm heading sentence case is correct throughout

🤖 Generated with Claude Code

…tation

Adds documentation for the new Errors tab on the Tasks page, including
the 7-day interactive error timeline chart. Also fixes heading capitalization
to sentence case throughout the page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label May 12, 2026
@linear
Copy link
Copy Markdown

linear Bot commented May 12, 2026

TSP-1231

@github-actions
Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 1 file (1 with issues, 0 clean)

Scores

Dimension Score What's holding it back
🟡 Consistency 6/10 Title, sidebarTitle, and main H2 all use title case instead of sentence case. Four <Tip> callouts have a redundant "Quick Tip:" prefix. Page description doesn't match page content.
🟡 Technical clarity 7/10 UI sections are specific and usable, but five <img> tags have no alt attributes, and the frontmatter description promises a conceptual comparison that the page never delivers.
🟡 Non-technical clarity 7/10 Good analogies ("like your email inbox", "mission control center"), but the page never defines what a "task" actually is before describing the UI layout for managing tasks.
🟡 Structure 6/10 Description-to-content mismatch is the main gap — the page reads as a UI tour, not the concept/overview page the description and title suggest. No closing CTA for what is the section's overview page.

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: Solid, readable UI walkthrough with good use of analogies — a non-technical reader can follow it without trouble. The main problem is that the frontmatter (title, sidebarTitle, description) doesn't match what the page actually contains: the description promises "what are tasks and how do they differ from prompt?" but the page answers neither question, focusing entirely on the Tasks Page layout instead.

🔧 Issues (9)
  • task-overview.mdx:2 — Title "Give Your Agent Tasks" → sentence case: "Give your Agent tasks" ("Your" and "Tasks" are not proper nouns)
  • task-overview.mdx:3 — sidebarTitle "Tasks Overview""Tasks overview" ("Overview" is not a proper noun)
  • task-overview.mdx:4 — Description "What are tasks and how do they differ from prompt?" doesn't match page content (the page describes the Tasks Page UI, not what tasks are conceptually). Also "prompt" should be "prompts". Either update the description to match the actual content, or add a concept section to the page that answers the question.
  • task-overview.mdx:12 — Heading ## Tasks Page: Your Command Center for Agent Activity → sentence case: ## Tasks page: your command center for Agent activity ("Your", "Command", "Center", "For", "Activity" are all regular words, not proper nouns; "Agent" stays capitalized as a Relevance AI product term)
  • task-overview.mdx:7<img> missing alt attribute
  • task-overview.mdx:22<img> missing alt attribute
  • task-overview.mdx:46<img> missing alt attribute
  • task-overview.mdx:61<img> missing alt attribute
  • task-overview.mdx:76<img> missing alt attribute
🧩 Component suggestions (2)
  • task-overview.mdx:34,58,73,92 — All four <Tip> callouts open with "Quick Tip:" as inline text. Mintlify already renders a "Tip" label on the component — the prefix is redundant. Remove it and start with the actual guidance sentence (e.g. <Tip>Use the search and filter options to quickly find specific tasks when your list grows.</Tip>).
  • task-overview.mdx:98–101 — The four numbered steps ("Use the left sidebar...", "Review your agent's work...", etc.) are a sequential procedure. Replace the plain numbered list with <Steps> to add visual progress indicators.
🏗️ Page structure (3)
  • task-overview.mdx — No concept definition before the UI tour. Readers land on this page not knowing what a "task" is or how it differs from a regular chat prompt. Add a short opening paragraph that defines a task (e.g. "A task is a discrete unit of work your Agent carries out...") before the Tasks Page section breakdown begins.
  • task-overview.mdx — No closing CTA. This is the overview page for the "Give your Agent tasks" section, so readers who just finished it need somewhere to go next. A ## What's next? linking to /build/agents/give-your-agent-tasks/approval-mode and /build/agents/give-your-agent-tasks/bulk-schedule would round it off naturally.
  • task-overview.mdx:12–18 — The H2 ## Tasks Page: ... is followed immediately by the H3 ### Your workspace at a glance with no body text between them. Either drop the H3 (let the H2 carry the intro) or add a sentence of context under the H2 before the subheading.
🔋 Credit usage
Item Count
Files reviewed 1
Context pages read 2
Total lines processed ~200

Files read: build/agents/give-your-agent-tasks/task-overview.mdx (104 lines), build/agents/give-your-agent-tasks/interact-with-your-agent.mdx (84 lines), build/agents/give-your-agent-tasks/approval-mode.mdx (96 lines)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant