Repository navigation
docs(web): say what each Web source file is for - #220
Merged
Merged
Conversation
Add a one-to-three-line opening comment to every Web component and hook under apps/web/src/components that lacked one. Comment-only; no code changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment-only; no code changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Comment-only; no code changes. run-state.ts is left for the P5 migration. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Every Web source file now opens with a comment saying what it is for. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
yxflc11
marked this pull request as ready for review
October 10, 2026 15:42
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a short opening comment to the 129 Web source files under
apps/web/srcthat did not start with one, so a contributor or coding agent can tell at a glance what a file is and when to change it. Each comment was written after reading the file and its callers, and names the screen, artboard or API it covers.This is a comment-only change: 129 files, 204 added lines, 0 deleted, no code edits.
apps/web/src/run-state.tsis intentionally left out because it is part of the P5 migration.Examples:
components/ContextRail.tsx:// Right rail for a 频道 (Main and ChannelInfo artboards): details, 资料库 and members tabs, with/// approvals, recent runs and work computers. A 单聊 uses BotInfoRail instead.components/TaskSheet.tsx:// 任务详情 sheet (TaskInspector artboard): a task's status, computer frame, 分工, steps, outputs and/// model use, opened from a task card.sidebar-organization.ts:// Per-device sidebar arrangement in localStorage: pins, groups, folding, hidden rows, mute and/// unread marks, plus the sort and search used by the sidebar. Never a Server write.bounded-response.ts:// Reads a fetch response body with a byte limit, so a large or endless body cannot exhaust memory.preview/transport.ts:// Design preview fake Server (dev only): replaces fetch, EventSource and storage and answers every/// route from the synthetic world. Fails closed and never touches the network.Draft until P5 merges.
scripts/hygiene-baseline.jsonis not touched here because its owner changes during P5. After P5 merges, the owner lowersundocumentedFiles["apps/web"]from 130 to 1 (onlyrun-state.tsremains, unless P5 documents it).Checks
npx biome check --writeon the 129 changed files, thennpx biome linton them: lint exit 0 (12 warnings and 1 info, all from existing code).biome checkalso wanted import-order or format fixes inapi.ts,desktop-runtime.ts,plugin-api.ts,components/ImportEmployeeDialog.tsxandcomponents/useModalDialog.ts. That drift is already onmain(confirmed againstorigin/main), so those fixes were reverted to keep this PR comment-only.npm run typecheck: passed.npm run test --workspace @openbot/web: 93 files and 695 tests passed.node scripts/check-hygiene.ts: expected failure only:apps/web: only 1 files lack an opening comment now; lower undocumentedFiles["apps/web"] ... to 1.node scripts/check-docs.ts: passed (309 Markdown files).🤖 Generated with Claude Code