Skip to content

(janitor/comments) remove noise comments from apps/storybook - #8891

Open
kilo-code-bot[bot] wants to merge 1 commit into
mainfrom
janitor/comments-storybook
Open

kilo-code-bot[bot] wants to merge 1 commit into
mainfrom
janitor/comments-storybook

Conversation

@kilo-code-bot

@kilo-code-bot kilo-code-bot Bot commented Oct 25, 2026

Copy link
Copy Markdown
Contributor

Package or topic area cleaned

apps/storybook — the Storybook app package: stories/ (root, cloud-agent/, shared/) and src/mockData/. Selected after ranking comment-dense areas across the repo; the storybook package had the largest concentration of low-confidence-value comments (banners and restatement), while every other candidate area inspected (kilo-* services, gastown, mobile, cloud-agent-sdk, web-shared, integrations) contains carefully curated "why" comments that were left alone.

Files touched (12)

  • apps/storybook/stories/SignInForm.stories.tsx
  • apps/storybook/stories/cloud-agent/ProfileVarEditor.stories.tsx
  • apps/storybook/stories/cloud-agent/ProfilesListDialog.stories.tsx
  • apps/storybook/stories/cloud-agent/ProfileSelector.stories.tsx
  • apps/storybook/stories/cloud-agent/SaveProfileDialog.stories.tsx
  • apps/storybook/stories/cloud-agent/SetupCommandsDialog.stories.tsx
  • apps/storybook/stories/cloud-agent/EnvVarsDialog.stories.tsx
  • apps/storybook/stories/shared/ModelCombobox.stories.tsx
  • apps/storybook/stories/UpgradeTrialDialog.stories.tsx
  • apps/storybook/stories/FreeTrialWarningBanner.stories.tsx
  • apps/storybook/src/mockData/constants.ts
  • apps/storybook/src/mockData/providers.ts

Comment lines removed

68 comment lines (78 total deletions including 10 directly resulting whitespace collapses).

Categories of noise removed

  • Section banner separators (// ====... STATE NAME ====...) duplicating the adjacent story export names
  • JSX branch narration ({/* Tab navigation */}, {/* Variables Tab */}, // Edit mode, // View mode, {/* Add new variable form */}, {/* Summary of what will be saved */})
  • Prop/state group labels restating the names that follow (// Add variable state, // Edit variable state, // Loading states)
  • Captions restating the function below (// Wrapper component to handle state, // Interactive wrapper to control dialog state)
  • Fixture labels restating literal data (// Anthropic, // OpenAI, … vendor labels over model ids; // Owner-specific examples for specific states over Owner_* story names)
  • Mock-data restatement (// Constant data used in our stories., // Ensure all required fields have defaults)

Important comments intentionally retained

  • File-header explanations of story harness constraints (Radix pointerdown vs click, gastown tRPC provider isolation, self-stateful drawers, fixture mirroring orderNewAccountProviders discovery)
  • Story JSDoc titles — they are rendered by Storybook autodocs
  • Inline fixture-intent notes (// no vision support = no icon, the google-first ordering notes in SignInForm)
  • random.ts usage contract ("Stories should import and use this instead of creating their own RNG instances")
  • ModeCombobox/ModelCombobox compact-variant usage context (chat footer toolbar)

Suppressions

None touched. No lint/type directives existed among the removed lines.

Follow-up refactor candidates

None. No deleted comment was load-bearing for understanding; no symbol needs refactoring.

Validation performed

  • Reviewed every deleted line in the diff: all are comments or resulting whitespace; no code, types, assertions, or public API changed
  • pnpm typecheck in apps/storybook (tsgo --noEmit) — passes
  • oxlint apps/storybook/stories apps/storybook/src — clean (exit 0)
  • oxfmt --check on touched directories — all files correctly formatted
  • No test suite exists for this package (stories are exercised via Chromatic screenshots; no assertions or behavior changed)

Delete banner separators, JSX section narration, prop/state group labels
that restate names, and 'Wrapper component to handle state' captions that
restate the function below them. Comment-only change; no directives,
public contracts, or behavior touched.
@kilo-code-bot kilo-code-bot Bot added the janitor Automated dead-code/duplication cleanup label Oct 25, 2026
@kilo-code-bot
kilo-code-bot Bot enabled auto-merge October 25, 2026 08:06
@kilo-code-bot

kilo-code-bot Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor Author

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Executive Summary

Comment-only deletion across 12 apps/storybook story and mock-data files; I verified every removed line in the diff is a comment or adjacent blank line, with no code, JSX expression, export, or directive touched, so behavior and Storybook autodocs are unchanged.

Assumptions: [INFERENCE] I did not run typecheck/oxlint/oxfmt (read-only review); the PR reports those passing, and the diff contains zero non-comment removals and zero additions, so the syntax risk is limited to JSX comment removal, which I checked in ProfileVarEditor.stories.tsx, ProfilesListDialog.stories.tsx, and SaveProfileDialog.stories.tsx — each removed {/* ... */} sat between sibling JSX elements in a valid branch.

Files Reviewed (12 files)
  • apps/storybook/src/mockData/constants.ts - comment-only deletions, no issues
  • apps/storybook/src/mockData/providers.ts - comment-only deletion, no issues
  • apps/storybook/stories/FreeTrialWarningBanner.stories.tsx - owner/member group labels removed, story exports intact
  • apps/storybook/stories/SignInForm.stories.tsx - 9 banner separators removed, story exports and retained fixture-intent note intact
  • apps/storybook/stories/UpgradeTrialDialog.stories.tsx - wrapper caption removed, no issues
  • apps/storybook/stories/cloud-agent/EnvVarsDialog.stories.tsx - wrapper caption removed, no issues
  • apps/storybook/stories/cloud-agent/ProfileSelector.stories.tsx - wrapper caption removed, no issues
  • apps/storybook/stories/cloud-agent/ProfileVarEditor.stories.tsx - prop-group labels and JSX branch narration removed; ternary branches still valid
  • apps/storybook/stories/cloud-agent/ProfilesListDialog.stories.tsx - edit/view mode narration and form comment removed, no issues
  • apps/storybook/stories/cloud-agent/SaveProfileDialog.stories.tsx - summary JSX comment and wrapper caption removed, no issues
  • apps/storybook/stories/cloud-agent/SetupCommandsDialog.stories.tsx - wrapper caption removed, no issues
  • apps/storybook/stories/shared/ModelCombobox.stories.tsx - fixture grouping comments removed; model ids retain vendor prefixes so grouping stays obvious

Reviewed by deepseek-flash-latest · Input: 39.5K · Output: 3.2K · Cached: 265.7K

Review guidance: REVIEW.md from base branch main

This branch has not been deployed

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

Labels

janitor Automated dead-code/duplication cleanup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants