Skip to content

docs: trim README to a non-technical, user-facing page#67

Merged
vreshch merged 1 commit into
masterfrom
docs/readme-trim
Jun 21, 2026
Merged

docs: trim README to a non-technical, user-facing page#67
vreshch merged 1 commit into
masterfrom
docs/readme-trim

Conversation

@vreshch

@vreshch vreshch commented Jun 21, 2026

Copy link
Copy Markdown
Member

Removes the developer/technical sections so the README reads for end users:

  • Building from source (npm/esbuild/vitest commands) - removed.
  • How it works (git internals, isomorphic-git transport, force-push semantics) - removed.
  • Mobile (planned) (isDesktopOnly internals) - removed; the desktop-only status is now a one-line banner.

Also de-jargoned the leftover references (status banner, Features sign-in/merge bullets, FAQ) and fixed the now-dead #mobile-planned anchors. Kept the required disclosures (Privacy network/hosts + isomorphic-git attribution) so check:docs/check:hosts still pass. Docs-only; no version bump.

@github-actions

Copy link
Copy Markdown

🎉 PR Validation ✅ PASSED

Commit: 3335b4d59a50a7a5fb810702bbfa1b8d30a7776d
Branch: docs/readme-trim

Checks:

  • ✅ Dependencies installed
  • ✅ Type check passed
  • ✅ Linting passed
  • ✅ Format check passed
  • ✅ Tests + coverage passed
  • ✅ Build successful
  • ✅ Store-compliance checks passed
  • ✅ Bundle is mobile-safe

Ready to merge!


🔗 View workflow run

@vreshch vreshch merged commit 2435765 into master Jun 21, 2026
1 check passed
@vreshch vreshch deleted the docs/readme-trim branch June 21, 2026 10:49
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