Skip to content

docs: document how to change the CLI icon - #83

Merged
lmjabreu merged 4 commits into
mainfrom
luis/document-icon-update
Oct 21, 2026
Merged

lmjabreu merged 4 commits into
mainfrom
luis/document-icon-update

Conversation

@lmjabreu

Copy link
Copy Markdown
Contributor

Overview

Adds docs/icon.md with the steps for changing the CLI icon, plus a pointer in AGENTS.md. The main rule: never rename or delete files in icons/, because each install's OAuth client keeps the logo_uri it registered with (the cause of #82). It also lists the copies in Doist/comms-web that need updating alongside.

Reference

Follows #79 and #82.

Test plan

Not applicable: docs only.

🤖 Generated with Claude Code

@lmjabreu lmjabreu added the 👀 Show PR requires passing checks before merge and independent human review before or after merge. label Oct 17, 2026
@lmjabreu
lmjabreu force-pushed the luis/document-icon-update branch from 85007da to 68beae6 Compare October 17, 2026 15:35
@lmjabreu

Copy link
Copy Markdown
Contributor Author

@doistbot /review

@doistbot doistbot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_SVG in src/lib/auth-pages.ts, which renders the same Size=72, Style=Color artwork 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.

Share Feedback • Review Logs

Comment thread docs/icon.md Outdated
@lmjabreu
lmjabreu force-pushed the luis/document-icon-update branch from 68beae6 to 4e3b698 Compare October 17, 2026 16:44
@lmjabreu
lmjabreu marked this pull request as ready for review October 17, 2026 17:14
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lmjabreu
lmjabreu force-pushed the luis/document-icon-update branch from 4e3b698 to 5216a6c Compare October 19, 2026 22:05
@lmjabreu

Copy link
Copy Markdown
Contributor Author

@doistbot /review

@doistbot doistbot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
  • P3 docs/icon.md:9: icons/ is not included in the npm package (package.json files is only dist, scripts, CHANGELOG.md), so icons/comms-cli.png isn'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 add icons to files (in which case the npm copy updates on release, not on push to main).

Share Feedback • Review Logs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lmjabreu
lmjabreu merged commit bac318a into main Oct 21, 2026
6 checks passed
@lmjabreu
lmjabreu deleted the luis/document-icon-update branch October 21, 2026 07:40
@doist-release-bot

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 3.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

released 👀 Show PR requires passing checks before merge and independent human review before or after merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants