Repository navigation
docs: document how to change the CLI icon - #83
Conversation
85007da to
68beae6
Compare
|
@doistbot /review |
doistbot
left a comment
There was a problem hiding this comment.
Docs-only PR adding docs/icon.md with the steps for changing the CLI icon (plus a pointer in AGENTS.md). The doc accurately describes the update process, the OAuth client logo_uri caching constraint behind never renaming/deleting files in icons/, and the cross-repo copies in Doist/comms-web — the PNG-based locations and LOGO_URI target all match the code.
Few things worth tightening:
- The "three places" checklist omits
COMMS_CLI_ICON_SVGinsrc/lib/auth-pages.ts, which renders the sameSize=72, Style=Colorartwork on the OAuth success and failure pages. Following the current steps would leave those pages showing the old icon — worth adding it as a fourth location with a step to regenerate/replace it.
68beae6 to
4e3b698
Compare
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
4e3b698 to
5216a6c
Compare
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
@doistbot /review |
doistbot
left a comment
There was a problem hiding this comment.
Docs-only PR adding docs/icon.md with the process for changing the CLI icon, plus a pointer in AGENTS.md and a matching comment update in auth-constants.ts. No inline issues were flagged — the doc's steps check out against the code (LOGO_URI → icons/comms-cli.png, the OAuth logo_uri registration, and the sign-in result pages that now render it), the comms-web copies are correctly listed, and the earlier auth-pages gap is already resolved. Nothing security- or reuse-relevant introduced; nice to have the "never rename/delete icons/ files" constraint captured in writing given the released-client logo_uri caching pitfall.
I also left one optional follow-up note in the details below.
Optional follow-up note (1)
docs/icon.md:9:
icons/is not included in the npm package (package.jsonfilesis onlydist,scripts,CHANGELOG.md), soicons/comms-cli.pngisn't in the published tarball and the npm README's relative image reference can't resolve. Overwriting the repo file updates only GitHub. Either drop "and npm" here, or addiconstofiles(in which case the npm copy updates on release, not on push to main).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
🎉 This PR is included in version 3.7.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Overview
Adds
docs/icon.mdwith the steps for changing the CLI icon, plus a pointer inAGENTS.md. The main rule: never rename or delete files inicons/, because each install's OAuth client keeps thelogo_uriit registered with (the cause of #82). It also lists the copies inDoist/comms-webthat need updating alongside.Reference
Follows #79 and #82.
Test plan
Not applicable: docs only.
🤖 Generated with Claude Code