Conversation
Inserted HTML comments throughout README and docs to suggest relevant screenshots, including hero images, setup wizards, status indicators, and success messages. These additions guide future documentation improvements and help clarify user flows for both personal and enterprise scenarios.
shawntz
changed the title
There was a problem hiding this comment.
Pull request overview
This PR adds HTML comment placeholders throughout the documentation to guide future screenshot additions. The comments provide specific guidance on image placement, suggested file paths, dimensions, and visual content for each screenshot.
Key Changes:
- Added 13 HTML comment blocks suggesting screenshot placements across documentation files
- Included detailed guidance on screenshot dimensions (ranging from ~300px to ~800px wide)
- Provided specific visual descriptions for complex screenshots (e.g., menu states, multi-account views)
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
docs/index.md |
Added 7 screenshot suggestion comments covering hero images, setup wizards, key rotation UI, enterprise SSO, multi-account views, and success messages |
docs/getting-started.md |
Added 1 screenshot suggestion comment for the personal account setup wizard modal |
docs/client.md |
Added 2 screenshot suggestion comments for menu bar dropdown and status indicator states |
README.md |
Added 7 screenshot suggestion comments mirroring the structure in docs/index.md for consistency between README and documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Enterprise users** — see [Server Setup](server-setup.md) for CA and Entra configuration. | ||
|
|
||
| <!-- SCREENSHOT: Setup wizard showing the two options (Enterprise / Personal) --> | ||
| <!-- Suggested: assets/screenshots/setup-wizard.png --> |
There was a problem hiding this comment.
Path inconsistency: This suggests assets/screenshots/setup-wizard.png but README.md line 48 uses docs/assets/screenshots/setup-wizard.png for the same screenshot. These paths should be consistent. Since this file is in the docs/ directory and getting-started.md uses ../assets/screenshots/, the path should likely be assets/screenshots/setup-wizard.png.
| cassh issues **12-hour certificates** signed by your internal CA. No revocation lists to manage, no keys to track, no manual intervention needed. | ||
|
|
||
| <!-- SCREENSHOT: Enterprise flow - showing the meme landing page with SSO button --> | ||
| <!-- Suggested: assets/screenshots/enterprise-sso-landing.png --> |
There was a problem hiding this comment.
Path inconsistency: This suggests assets/screenshots/enterprise-sso-landing.png but README.md line 89 uses docs/assets/screenshots/enterprise-sso-landing.png for the same screenshot. These paths should be consistent. Since this file is in the docs/ directory and getting-started.md uses ../assets/screenshots/, the path should likely be assets/screenshots/enterprise-sso-landing.png.
| 5. On rotation: deletes old key from GitHub, generates new key, uploads new key | ||
|
|
||
| <!-- SCREENSHOT: Personal connection success message after setup --> | ||
| <!-- Suggested: assets/screenshots/personal-setup-success.png --> |
There was a problem hiding this comment.
Path inconsistency: This suggests assets/screenshots/personal-setup-success.png but README.md line 144 uses docs/assets/screenshots/personal-setup-success.png for the same screenshot. These paths should be consistent. Since this file is in the docs/ directory and getting-started.md uses ../assets/screenshots/, the path should likely be assets/screenshots/personal-setup-success.png.
| 5. Certificate expires in 12 hours — repeat as needed | ||
|
|
||
| <!-- SCREENSHOT: Enterprise certificate success page --> | ||
| <!-- Suggested: assets/screenshots/enterprise-cert-success.png --> |
There was a problem hiding this comment.
Path inconsistency: This suggests assets/screenshots/enterprise-cert-success.png but README.md line 161 uses docs/assets/screenshots/enterprise-cert-success.png for the same screenshot. These paths should be consistent. Since this file is in the docs/ directory and getting-started.md uses ../assets/screenshots/, the path should likely be assets/screenshots/enterprise-cert-success.png.
| <!-- Suggested: assets/screenshots/enterprise-cert-success.png --> | |
| <!-- Suggested: ../assets/screenshots/enterprise-cert-success.png --> |
| - **Red status** = Expired, click to renew | ||
|
|
||
| <!-- SCREENSHOT: Menu bar showing green/yellow/red status states --> | ||
| <!-- Suggested: assets/screenshots/status-indicators.png --> |
There was a problem hiding this comment.
Path inconsistency: The suggested path assets/screenshots/status-indicators.png should be consistent with other files in the docs/ directory. Based on getting-started.md line 50 which uses ../assets/screenshots/, this should likely be assets/screenshots/status-indicators.png if the assets folder is within docs, or ../assets/screenshots/status-indicators.png if it's at the repository root.
| <!-- Suggested: assets/screenshots/status-indicators.png --> | |
| <!-- Suggested: ../assets/screenshots/status-indicators.png --> |
| Whether you're a solo developer managing personal projects or an enterprise team with hundreds of engineers, `cassh` brings security best practices to your SSH workflow — without the complexity. | ||
|
|
||
| <!-- SCREENSHOT: Hero image showing menu bar with multiple connections (enterprise + personal) --> | ||
| <!-- Suggested: assets/screenshots/hero-menubar.png --> |
There was a problem hiding this comment.
Path inconsistency: In docs/index.md, the suggested path is assets/screenshots/hero-menubar.png (relative), but in README.md the same screenshot uses docs/assets/screenshots/hero-menubar.png (absolute from root). Since this file is in the docs/ directory, the path should be ../assets/screenshots/hero-menubar.png or assets/screenshots/hero-menubar.png depending on whether the assets folder is at the repository root or within the docs/ directory. For consistency with the path used in getting-started.md (line 50), this should likely be assets/screenshots/hero-menubar.png.
| > **Security isn't just for enterprises.** Your personal GitHub account has access to your private repos, your contributions to other projects, and possibly deploy keys. Treat it accordingly. | ||
|
|
||
| <!-- SCREENSHOT: Key rotation dropdown in setup wizard showing duration options --> | ||
| <!-- Suggested: assets/screenshots/key-rotation-options.png --> |
There was a problem hiding this comment.
Path inconsistency: This suggests assets/screenshots/key-rotation-options.png but README.md line 72 uses docs/assets/screenshots/key-rotation-options.png for the same screenshot. These paths should be consistent. Since this file is in the docs/ directory and getting-started.md uses ../assets/screenshots/, the path should likely be assets/screenshots/key-rotation-options.png.
| <!-- Suggested: assets/screenshots/key-rotation-options.png --> | |
| <!-- Suggested: ../assets/screenshots/key-rotation-options.png --> |
| Most developers juggle multiple GitHub accounts — work and personal, or multiple organizations. cassh manages them all from a single menu bar app. | ||
|
|
||
| <!-- SCREENSHOT: Menu bar showing multiple connections with different statuses --> | ||
| <!-- Suggested: assets/screenshots/multi-account-menubar.png --> |
There was a problem hiding this comment.
Path inconsistency: This suggests assets/screenshots/multi-account-menubar.png but README.md line 99 uses docs/assets/screenshots/multi-account-menubar.png for the same screenshot. These paths should be consistent. Since this file is in the docs/ directory and getting-started.md uses ../assets/screenshots/, the path should likely be assets/screenshots/multi-account-menubar.png.
| 5. Status will show green when active | ||
|
|
||
| <!-- SCREENSHOT: Menu bar dropdown showing connections and status --> | ||
| <!-- Suggested: assets/screenshots/menubar-dropdown.png --> |
There was a problem hiding this comment.
Path inconsistency: The suggested path assets/screenshots/menubar-dropdown.png should be consistent with other files in the docs/ directory. Based on getting-started.md line 50 which uses ../assets/screenshots/, this should likely be assets/screenshots/menubar-dropdown.png if the assets folder is within docs, or ../assets/screenshots/menubar-dropdown.png if it's at the repository root.
| <!-- Suggested: assets/screenshots/menubar-dropdown.png --> | |
| <!-- Suggested: ../assets/screenshots/menubar-dropdown.png --> |
|
fizzy |
Inserted HTML comments throughout README and docs to suggest relevant screenshots, including hero images, setup wizards, status indicators, and success messages. These additions guide future documentation improvements and help clarify user flows for both personal and enterprise scenarios.
Description
Type of Change
Related Issues
Closes #
How Has This Been Tested?
Test environment:
Checklist
Security Considerations
Screenshots (if applicable)