Skip to content

docs(readme): modernize the README layout - #335

Merged
eFAILution merged 2 commits into
betafrom
docs/readme-refresh
Oct 2, 2026
Merged

eFAILution merged 2 commits into
betafrom
docs/readme-refresh

Conversation

@eFAILution

@eFAILution eFAILution commented Oct 2, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Gives the README a facelift: centered header with Marketplace badges, a short quick start, one section per feature next to its demo, and the long reference parts (settings, advanced setup, troubleshooting) folded into collapsible sections.
  • Swaps in five re-recorded GIFs, one per feature, including a new one for version upgrades.
  • Link related issue(s): n/a

Change Type

  • feat
  • fix
  • refactor
  • docs
  • test
  • chore

Context

User-facing impact

  • Marketplace page and GitHub README look different. No behavior changes.

GitLab scope

  • both

Affected areas

  • Docs only

Validation

Local checks

  • vsce package passes with the new badges (it rejects untrusted SVG hosts)

Manual test notes

  • shields.io retired its VS Marketplace badges, so version and installs come from vsmarketplacebadges.dev.

Breaking Changes

  • No breaking changes

Screenshots / Recordings (if UI behavior changed)

  • New GIFs are in the README, uploaded in the comment below.

Risk and Rollback

  • Main risks: <details> or centered HTML rendering differently on the Marketplace than on GitHub.
  • Rollback strategy: revert the commit.

Release Notes Draft

  • Refreshed README and Marketplace page.

Checklist

  • Branch is up to date with target branch
  • Commit messages follow conventional commits
  • Added/updated docs for behavior or settings changes
  • Added/updated tests for new behavior
  • No secrets or tokens in code, logs, screenshots, or test fixtures

Centered header with Marketplace badges, a short quick start, one
section per feature next to its demo, and collapsible reference
sections for settings, advanced setup, and troubleshooting.
@github-actions

github-actions Bot commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

🛡️ Security Hardening Pipeline Results

Branch: docs/readme-refresh
Commit: 6cfad80

Workflow Run: 521
Branch: docs/readme-refresh
Commit: 6cfad80

Scan Status

Scanner Status
bandit ⏭️ skipped
checkov ⏭️ skipped
clamav ⏭️ skipped
codeql ✅ PASS
container ⏭️ skipped
dependency-review ✅ PASS
gitleaks ✅ PASS
grype ⏭️ skipped
lint ⏭️ skipped
opengrep ⏭️ skipped
osv ✅ PASS
sbom ⏭️ skipped
supply-chain ⏭️ skipped
trivy-container ⏭️ skipped
trivy-iac ⏭️ skipped
zap ⏭️ skipped

✅ All enabled scanners completed successfully.

Summaries Collected: 4

Scanner Results

🔬 CodeQL SAST (Javascript)

Status: Completed

Findings Summary

Critical High Medium Low Total
0 0 0 0 0

No security findings detected for Javascript.

Artifacts: CodeQL Reports (Javascript)

🔗 Dependency Review

Status: ✅ No issues found

No vulnerable or license-violating dependencies detected in this PR.
📋 View full report

🔑 Gitleaks (Secrets)

No 🔑 Gitleaks (Secrets) findings summary was produced.

📦 OSV (Dependencies)

No 📦 OSV (Dependencies) findings summary was produced.


Generated by Argus


Generated by Argus

@eFAILution

Copy link
Copy Markdown
Owner Author

New GIFs:
browse
complete
hover
validate
versions

Re-recorded demos for the Component Browser, completion, hover, input
checks, and version upgrades. Adds a GIF to the version section, which
had none.
@eFAILution
eFAILution merged commit fddb382 into beta Oct 2, 2026
23 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