Skip to content

Polish README with centered header and demo GIF#6

Merged
mshddev merged 1 commit intomainfrom
docs/readme-demo-gif
Apr 10, 2026
Merged

Polish README with centered header and demo GIF#6
mshddev merged 1 commit intomainfrom
docs/readme-demo-gif

Conversation

@mshddev
Copy link
Copy Markdown
Owner

@mshddev mshddev commented Apr 10, 2026

Summary

  • Adds a 23s vhs-recorded screencast (docs/demo.gif) of the core sonacli workflow: auth setup → project list → issue list | jq → severity filter → issue show from a pasted SonarQube URL.
  • Embeds the GIF under the badges in README.md, so the top of the page tells the whole story before any prose.
  • Ships the reproducible artifacts: docs/demo.tape (vhs script with full regen steps in the header) and docs/_demo-source/ (a small Go fixture exercising varied severities — INFO TODOs, MEDIUM FIXME, HIGH cognitive complexity). The fixture directory name starts with _ so Go tooling ignores it.
  • Also lands the centered logo and badge header that had been pending locally on main.

Test plan

  • make test passes locally
  • README renders correctly on GitHub (logo centered, badges, GIF below)
  • docs/demo.gif plays end-to-end on the PR page
  • docs/demo.tape header instructions are sufficient to regenerate the GIF on a clean environment

🤖 Generated with Claude Code

Adds a 23s vhs screencast of the core sonacli workflow — auth,
project list, jq-piped issue list, severity filter, and the
SonarQube URL paste trick — and embeds it under the badges.
Ships the vhs tape and Go demo fixture in docs/ so maintainers
can regenerate the GIF. Also lands the centered logo and badge
header that had been pending on main.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mshddev mshddev merged commit cc2e037 into main Apr 10, 2026
3 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.

1 participant