Skip to content

docs: reorder README to lead with user-facing content - #131

Merged
coldhighsun merged 1 commit into
mainfrom
docs/readme-user-first
Aug 6, 2026
Merged

docs: reorder README to lead with user-facing content#131
coldhighsun merged 1 commit into
mainfrom
docs/readme-user-first

Conversation

@coldhighsun

Copy link
Copy Markdown
Owner

Summary

  • Reorder both the English and Chinese README sections so Installation (incl. winget install coldhighsun.ManagedDrive), CLI Usage, wingetx, and Known Issues come right after Features, ahead of developer-only content.
  • Group build-from-source / architecture / image-format / benchmark sections under a new "For Developers" / "开发者内容" heading near the end.
  • No content deleted, only reordered; internal anchors verified to still resolve.

Test plan

  • git diff --stat README.md shows only README.md changed
  • Visually reviewed both language sections for section order and intact anchors

Move Installation, CLI Usage, wingetx, and Known Issues ahead of
developer-only sections (build from source, solution structure,
image format internals, benchmarks), which are now grouped under a
new "For Developers" section near the end. Also add the winget
install command. No content removed, only reordered.
@coldhighsun
coldhighsun merged commit 83e2853 into main Aug 6, 2026
3 checks passed
@coldhighsun
coldhighsun deleted the docs/readme-user-first branch August 6, 2026 05:35
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