Skip to content

docs(readme): clickable badges, correct product colors/logos, and one-click setup tiles#198

Merged
jatinkrmalik merged 4 commits into
mainfrom
docs/readme-badges-and-quickstart
Jul 8, 2026
Merged

docs(readme): clickable badges, correct product colors/logos, and one-click setup tiles#198
jatinkrmalik merged 4 commits into
mainfrom
docs/readme-badges-and-quickstart

Conversation

@jatinkrmalik

Copy link
Copy Markdown
Collaborator

What & why

Polishes the README header and adds a frictionless install experience.

1. All badges are now clickable

Previously several pills were static images. Every badge now links to a sensible destination — including all 6 product pills (Jira, Confluence, JSM, Bitbucket, Compass, Rovo).

2. Fixed product colors & logos

  • Confluence: #172B4D (dark navy) → Atlassian Blue #0052CC (correct brand color).
  • Jira Service Management: was using the wrong jirasoftware logo (and jiraservicemanagement has no Simple Icons slug) → now an embedded JSM SVG glyph on brand blue.

3. Two-tone product shields

All product pills now use a two-tone style: logo on a darker left segment (labelColor) with the product name on the brand-colored right segment.

4. One-click setup tiles

New One-click setup section mirroring atlassian.com/platform/rovo-mcp, with native install deep links for Cursor, VS Code, ChatGPT, and Claude. (VS Code/OpenAI icons were removed from Simple Icons, so those two use embedded SVG glyphs.)

Validation

  • All 18 shields.io URLs return HTTP 200.
  • node scripts/validate-template.mjs passes (only a pre-existing unrelated hooks warning).

Reviewer note

Badges/tiles render only after merge/preview on github.com — please spot-check the rendered README on the branch.

…d one-click setup tiles

- Wrap every badge (Official, Status, MCP, Auth, Hosting, and all 6 product pills) in links
- Fix Confluence color (172B4D dark navy -> Atlassian Blue 0052CC)
- Fix Jira Service Management logo (was jirasoftware / invalid slug) with embedded JSM glyph
- Convert product pills to two-tone shields (logo-left / title-right)
- Add 'One-click setup' section with Cursor, VS Code, ChatGPT, Claude install deep links
GitHub's HTML sanitizer strips custom URL schemes (cursor://, vscode:),
which made those two tiles non-clickable. Switch to the https redirect
install entry points that GitHub permits. Also remove the tip callout.
Remove em dash and tailing-negation fragment; avoid restating the heading.
SreeNerella
SreeNerella previously approved these changes Jul 8, 2026
Comment thread README.md Outdated
<br><sub>Reference issues and log work in your codebase.</sub>
</td>
<td align="center" width="180">
<a href="https://insiders.vscode.dev/redirect/mcp/install?name=Atlassian-Rovo-MCP&config=%7B%22url%22%3A%22https%3A%2F%2Fmcp.atlassian.com%2Fv1%2Fmcp%2Fauthv2%22%2C%22type%22%3A%22http%22%7D">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

should this just be vscode.dev ?

@jatinkrmalik jatinkrmalik Jul 8, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good call. I validated https://vscode.dev/redirect/mcp/install?... and it returns a 302 to the stable vscode:mcp/install?... handler with the expected MCP config.

sfatlas
sfatlas previously approved these changes Jul 8, 2026
@jatinkrmalik jatinkrmalik dismissed stale reviews from sfatlas and SreeNerella via ce7734f July 8, 2026 17:21
@jatinkrmalik jatinkrmalik merged commit f22e707 into main Jul 8, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants