docs(cli): document new banner customization settings#3885
Conversation
Add ui.customBannerTitle, ui.customBannerSubtitle, and ui.customAsciiArt to the user-facing settings table. Also reword ui.hideBanner to note that it covers both the logo column and the info panel and that Tips render independently. These settings landed in #3710 but only ui.hideBanner was listed in the table, so users had no way to discover the other three short of reading the schema or the design doc.
wenshao
left a comment
There was a problem hiding this comment.
No review findings. Downgraded from Approve to Comment: self-PR reviews cannot be approved by the author; CI is not fully green (Test (windows-latest, 20.x) failed; Test (macos-latest, 22.x) is still in progress). — gpt-5.5 via Qwen Code /review
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
tanzhenxin
left a comment
There was a problem hiding this comment.
Review
Pure docs-site fix that adds rows for the three banner customization settings (ui.customBannerTitle, ui.customBannerSubtitle, ui.customAsciiArt) and tightens the existing ui.hideBanner description. I spot-checked each documented cap against the runtime — title 80 chars, subtitle 160 chars, art 64 KB / 200 lines × 200 cols, plus the O_NOFOLLOW and per-scope path-resolution claims all match the implementation in customBanner.ts.
Verdict
APPROVE — accurate, well-grounded rows. The schema description for ui.hideBanner could optionally be harmonized with the new docs wording in a follow-up.
Add ui.customBannerTitle, ui.customBannerSubtitle, and ui.customAsciiArt to the user-facing settings table. Also reword ui.hideBanner to note that it covers both the logo column and the info panel and that Tips render independently. These settings landed in #3710 but only ui.hideBanner was listed in the table, so users had no way to discover the other three short of reading the schema or the design doc.
Add ui.customBannerTitle, ui.customBannerSubtitle, and ui.customAsciiArt to the user-facing settings table. Also reword ui.hideBanner to note that it covers both the logo column and the info panel and that Tips render independently. These settings landed in QwenLM#3710 but only ui.hideBanner was listed in the table, so users had no way to discover the other three short of reading the schema or the design doc.
Summary
#3710 added four
ui.*banner customization settings, but onlyui.hideBannerended up in the user-facing settings table atdocs/users/configuration/settings.md. This PR documents the other three so users can discover them without having to read the schema or the design doc:ui.customBannerTitleui.customBannerSubtitleui.customAsciiArtAlso tightens the existing
ui.hideBannerrow from "Hide the application banner." to call out that it covers both the logo column and the info panel and that Tips render independently — closer to the schema description and the design rationale.The schema (
packages/cli/src/config/settingsSchema.ts), the generated VS Code JSON Schema (packages/vscode-ide-companion/schemas/settings.schema.json), and the design doc (docs/design/customize-banner-area/) were already authoritative — this is purely a docs-site visibility fix, no code change.Test plan
git diffreview: only the four affected rows change.