Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Design] Redesign research components

Open
#164 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
bun, typescript
Domain
design, frontend

Research direction

Start at /design-audit#authored-content and inspect the research composer and SidecarCard-based lifecycle cards in packages/editor. Use the stated lifecycle stages and acceptance criteria to create the lifecycle state matrix, then verify with bun run types, bun run ci, bun test packages/editor, and bun run e2e. Done includes Maggie-approved specimens, screenshots at normal and narrow widths, reduced-motion and keyboard evidence, and confirmation that identity and publication semantics are unchanged.

Written by the indexing model from the issue text.

Description

Base branch: main
Branch: maggie/redesign-research-components
Depends on: None

Goal

Redesign the complete research request family so entry, progress, failure, cancellation, and ready states feel like one polished workflow.

Context From Planning

  • Every research component in /design-audit#authored-content currently feels underdesigned and needs a dedicated pass.
  • Research requests are inline durable cards, not standalone channels. Their identity survives failure, cancellation, and retry.
  • This is a human-reviewed design task; lifecycle semantics are already established and must be preserved.

Current Behavior

The research composer and SidecarCard-based lifecycle cards expose the necessary data and actions but have weak hierarchy, inconsistent action placement, and little visual continuity between queued, searching, analyzing, writing, publishing, failed, cancelled, and ready states.

Desired Behavior

Create a cohesive research composer and lifecycle-card family with clear progress, source/report metadata, calm loading states, legible recovery actions, and strong continuity from request to child document.

Acceptance Criteria

  • The audit covers composer empty/drafted/submitting/blocked/error states and every durable request stage: queued, searching, analyzing, writing, publishing, failed, cancelled, and ready.
  • State changes retain a stable card identity and do not visually imply a new request on retry.
  • Cancel, retry, remove, and open-child actions have consistent placement and hierarchy appropriate to each stage.
  • Ready state clearly presents title, summary, source count, Planner provenance, and navigation to the ordinary child document.
  • Loading/progress treatment respects reduced motion and does not rely on animation alone.
  • Existing persistence-before-publication, observational-read, retry, cancellation, and child-publication behavior remains unchanged.
  • Maggie approves the audit specimens before production migration.

Verification Commands

  • bun run types
  • bun run ci
  • bun test packages/editor
  • bun run e2e

Primary Surfaces

  • /design-audit#authored-content
  • Research composer and lifecycle cards in packages/editor
  • Parent document research request and child-document navigation

Expected PR Checks

  • Repo required checks

Report Requirements

  • Complete lifecycle state matrix
  • Before/after screenshots at normal and narrow widths
  • Reduced-motion and keyboard evidence
  • Confirmation that request identity and publication semantics are unchanged

Implementation Notes

  • A pending request remains an inline card with no URL, sidebar row, Conversation, or Decisions.
  • Failure, cancellation, and retry preserve request identity; reads must not restart terminal work.
  • Publication remains idempotent and persistent before the ready card or navigation row appears.

Stop Conditions

  • The design implies a new product workflow such as standalone research workspaces or grandchildren.
  • A visual change requires altering durable lifecycle or publication ordering.
Dominant language
TypeScript
Stars
351
Forks
20
Avg merge
14h 7m
Merged PRs (30d)
34

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from githubnext/chopin

All issues in githubnext/chopin

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.