Skip to content

docs: redesign the README - #8

Merged
mpge merged 1 commit into
mainfrom
docs/readme-redesign
Nov 13, 2026
Merged

mpge merged 1 commit into
mainfrom
docs/readme-redesign

Conversation

@mpge

@mpge mpge commented Nov 13, 2026

Copy link
Copy Markdown
Member

Rewrites the README in the shared product-first layout (header, link row, two feature rows, full features grid, Built with row, quick start, Learn more).

Removed sections moved verbatim into docs/:

  • docs/features.md: Features, Screenshots
  • docs/install.md: Install, Set up a store
  • docs/configuration.md: Configuration, Permissions, Compatibility
  • docs/development.md: Develop and test (with CI and releases)
  • docs/faq.md: FAQ
  • docs/sync-options.md: License (with its GraphQL page sizes, client credentials, historical backfills and payment subsections) and Shipment fulfilment and tracking
  • The Contents list is dropped (the README no longer has those sections).

Rewrite the README in the shared short, product-first layout: centred header, link row, feature rows, a features grid, a Built with row, quick start and a Learn more list.

Removed README sections moved verbatim into docs/:
- docs/features.md: Features, Screenshots
- docs/install.md: Install, Set up a store
- docs/configuration.md: Configuration, Permissions, Compatibility
- docs/development.md: Develop and test (with CI and releases)
- docs/faq.md: FAQ
- docs/sync-options.md: License (with its GraphQL page sizes, client credentials, historical backfills and payment subsections) and Shipment fulfilment and tracking
- The Contents list is dropped (the README no longer has those sections).
@mpge
mpge merged commit 7db2a00 into main Nov 13, 2026
6 checks passed
@mpge
mpge deleted the docs/readme-redesign branch November 13, 2026 05: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