Skip to content

docs: refresh README presentation - #25

Merged
pentaoa merged 1 commit into
mainfrom
docs/readme-refresh
Sep 18, 2026
Merged

pentaoa merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@pentaoa

@pentaoa pentaoa commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • redesign the README around the existing sustech-cli visual identity
  • add a centered SVG wordmark, compact badges, navigation, and a lightweight hero image
  • replace the long command-manual layout with a focused quick start, capability map, agent workflow, and safety overview
  • keep detailed behavior in the existing documentation

Validation

  • verified README example commands against the current CLI
  • verified all local documentation and asset links
  • ran git diff --check
  • dry-run package size: 693 KB compressed; new visual assets total about 56 KB

@pentaoa
pentaoa merged commit b9a86ef into main Sep 18, 2026
6 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