Skip to content

docs: leaner READMEs with a real run image - #7

Merged
BlueBirdBack merged 1 commit into
mainfrom
devin/readme-lean
Oct 11, 2026
Merged

BlueBirdBack merged 1 commit into
mainfrom
devin/readme-lean

Conversation

@BlueBirdBack

Copy link
Copy Markdown
Contributor

Second pass per blank-reader-30s-test:

  • ~40% shorter (151→104 zh, 153→112 en)
  • Drop bottom glossary table (the protocol explicitly calls it unread; terms stay as inline first-use parens)
  • Merge 'run / commands / help' into one block
  • Fold install-failure / network / files / language notes into a single 'Behavior notes' section
  • Lead with the real-run screenshot already in assets/ so a fresh reader sees the output shape before reading prose

Apply the blank-reader pass again: cut ~40% length, drop the glossary
table (protocol says glossaries at the bottom go unread — terms stay
inline at first use), merge command list into one block, fold install/
network/file notes into a single behavior section, and lead with the
real run screenshot so readers see the output shape before scrolling.
@BlueBirdBack
BlueBirdBack merged commit cc4dd9f into main Oct 11, 2026
2 checks passed
@BlueBirdBack
BlueBirdBack deleted the devin/readme-lean branch October 11, 2026 13:15
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