Skip to content

docs: rewrite README with a fresh structure and voice - #201

Merged
gnacho merged 2 commits into
mainfrom
docs/200-readme-rewrite
Aug 27, 2026
Merged

docs: rewrite README with a fresh structure and voice#201
gnacho merged 2 commits into
mainfrom
docs/200-readme-rewrite

Conversation

@gnacho

@gnacho gnacho commented Aug 27, 2026

Copy link
Copy Markdown
Owner

Closes #200.

Full rewrite of README.md and README.es.md, moving away from the structure inherited from the old Python codebase and its upstream README:

  • New header: landing tagline, icon back, lean honest badge set (CI, version, license)
  • Hero screenshot via with prefers-color-scheme, reusing the sanitized landing shots (EN shots in README.md, ES shots in README.es.md)
  • New sections: What it is, first-person Why it exists (NextSync as the Rust rewrite of nextsync-py; the fork lineage lives in the nextsync-py README), What it does (grouped by theme), Providers, Install (Arch package + from source), First run, Deletions travel both ways, Files on disk, Development
  • Drops the cloned mermaid flowchart, the near-verbatim Highlights bullets and the stale Project status text (the GTK UI shipped many releases ago)
  • Kept: the bidirectional warning (rewritten in plain words) and the trademark disclaimer
  • EN-ES parity: 9/9 sections, no em dashes, no placeholders, no fork/ehstbr references, all referenced assets exist in the repo

Rendered preview: see the Files changed tab and the rendered README in the PR.

@gnacho
gnacho merged commit 771bab3 into main Aug 27, 2026
2 checks passed
@gnacho
gnacho deleted the docs/200-readme-rewrite branch August 27, 2026 17:13
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.

Rewrite README from scratch, away from the upstream fork's structure

1 participant