Repository navigation
refactor(settings): keep tip prose apart from on-row description - #20510
Conversation
e6decc6 to
c751b5d
Compare
Design Review (Opus 5.5) — ✅ PASSDesign-level review of Design-Verdict: PASS Nothing to check. [DESIGN-REVIEWED] a2848fe Description read[DESCRIPTION-READ] be5ecbdf9f1533e0df5d1bd3b05903f792bd94cc2ffe33f7950033c97120cf9d That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
UX Review (Opus 5.5) — ✅ PASSUX-level review of UX-Verdict: PASS Nothing to check. [UX-REVIEWED] a2848fe Description read[DESCRIPTION-READ] 888eb394addc847878947005cb493ec2e511bcf8835a5889cdfd60ea1d89bd01 That sha256 names everything this verdict read: the PR description, plus the 3 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
First Principles Review (Opus 5.5) — ✅ PASSPremise-level review of First-Principles-Verdict: PASS Check that the agent still answers well when What this change shipsInventory (6 items) — 6 justifiedIntent: let a reader of the settings registry tell which help text a row shows on screen and which sits behind its info tip (closes #15893). This is a FIX.
[FIRST-PRINCIPLES-REVIEWED] a2848fe Description read[DESCRIPTION-READ] 0a69ba6fa61c8c71fa2c6e42031ece204bf442aaa8e56649956ddb36d82a23bf That sha256 names the PR description this verdict read. Recompute it with |
Opus 5.5 Review — ✅ no blocking findingsReviewed Verdict parsed from the review's SHA-scoped output markers for commit False positive or not applicable? A repository writer can comment: |
GPT 6.1 Review — ✅ no blocking findingsGPT 6.1 completed its review of This comment is updated in place on each push. Review detailsNo findings. False positive or not applicable? A repository writer can comment: |
50f43b8 to
abdbaf0
Compare
abdbaf0 to
a2848fe
Compare
|
HOLD at a2848fe. This head was pushed at 01:29Z as a rebase. Its CI and every AI review lane were still queued or running when I read it, and PR Readiness is pending. So there is no current-head review evidence yet. The change itself reads as sound. The extractor keeps What would clear this hold:
The two generated registry files are pinned by byte-match guards, and I did not read them line by line. I read the rest of the diff and the tests but did not run them. — crew-pr-reviewer (r102) |
KiroCrewCaptain
left a comment
There was a problem hiding this comment.
Approved by a maintainer who read the review lane notes and accepted them as follow-up work.
Problem / Motivation
Goal: The settings registry says which help text a row shows on screen and which sits behind its info tip.
Since #15823 moved most explanations into each row's info tip, the generated settings registry folds the tip text and the on-row text into one
descriptionfield. A reader ofsettingsRegistry.gen.tsorsettings-registry.generated.jsoncannot tell which words the row actually shows. Nothing quotes the field as on-row copy today, so nothing looks wrong yet. The first reader that does would show tip text as if the row displayed it.Why it matters
The agent reads the bundled JSON to tell users where a setting is. If it quotes a row's text, it should quote words the user can see. Fixing the shape now is cheap; fixing it after a reader depends on the merged field is not.
Not a goal
What changed (motivation → approach → change)
The extractor joined the
hintprop and thedescriptionprop into one string. It now keeps them apart:descriptionholds only the text the row shows, and a new optionalhintholds only the info-tip text. Both generated files carry the new field, and the scheme doc says which one is safe to quote.Search (the palette and the agent's
find_settings) and the palette subtitle join the two fields themselves, tip first, the same order as before, so they match and render exactly as they did. Across all 245 committed entries, tip plus description equals the olddescriptionbyte for byte. The agent'sfind_settingsanswer keeps them apart too: each row returnsdescription(on-row) andhint(tip), and thefind_settingtool text says which is which.Backwards compatibility
Compatible:
descriptionandhintare both optional, search and the palette subtitle still read the same joined help text, and no field was renamed. Afind_settingsrow whose help sits only in a tip now carries it inhintand an emptydescription.Reader: website/src/components/commandPalette/settingsSearchCore.ts:scoreSettingEntry -- chat -- reads
settingHelpText(entry), the same joined text as beforeReader: website/src/components/commandPalette/settingsTabLabel.ts:settingsSubtitle -- chat -- reads
settingHelpText(entry); settingsRegistry.test.ts subtitle caseReader: src/kiro_crew/dashboard/change_cards.py:find_settings -- chat -- matches on
_help_text(entry), returnsdescriptionandhintapart; test_find_setting_keeps_tip_text_apart_from_row_textReader: src/kiro_crew/mcp_guide.py:find_setting -- chat -- tool text names
descriptionandhint; test_change_cards.py passesReader: src/kiro_crew/dashboard/change_cards.py:_row_hits -- chat -- reads
_help_text(entry); test_change_cards.py passesReader: src/kiro_crew/guide_catalog.py:guidable_settings -- chat -- never read
description; unchangedTests
settingsRegistry.test.ts: the extractor putshintanddescriptionin their own fields; the agent registry keeps both unmerged;settingHelpTextand the subtitle still read both, tip first; no committed row'sdescriptionstarts with its own tip. The existing byte-match guards cover both regenerated files.settingsExtractCoverage.test.ts: the hint-indexing cases now pinhintanddescriptionas separate fields, andsettingHelpTextas the tip-first join.test_change_cards.py: afind_settingsrow returns tip text inhintand only on-row text indescription.test_settings_deeplink_registry.py:hintis an allowed agent field; the bundled JSON carries tips inhintand never repeats a tip at the start ofdescription;_help_textjoins tip then description.Manual verification
N/A — unit coverage sufficient: no rendered surface changes, and the byte-match guards pin both generated files to a live extraction.
Screenshots / video
Why no screenshot: the diff splits one field of the generated settings registry into two and every rendered string (palette title, subtitle, settings rows) stays byte-identical, so there is nothing new to show.
Related Issues
Closes #15893
Pattern harvest
Not generalizable: one extractor merged two props into one field on purpose when only search read it; the fix is this field split.
Checklist
feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...)