Skip to content

docs: redesign the README - #208

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 product-first layout used across the Escalated repos: the shared agent inbox screenshot, two feature rows, a features grid with every feature from the old list, a short quick start and a Learn more list.

Nothing is dropped. The old sections moved verbatim into docs/:

  • docs/features.md: Features
  • docs/getting-started.md: Installation, Quick Start with Chi, Quick Start with Standard Library, Embedding the admin
  • docs/configuration.md: Configuration
  • docs/api-routes.md: API Routes
  • docs/customization.md: Custom Ticket Actions, Custom Store, Ticket Statuses, Priorities, Translations, Configurable ticket access and routing
  • docs/newsletters.md: Newsletters

The 13 translations in docs/translations/ are regenerated from the new README. All relative links were checked.

Leads with the shared agent inbox screenshot, two feature rows, a features grid, a short quick start and a link list. The sections it used to hold moved verbatim into docs/: features.md (Features), getting-started.md (Installation, both quick starts, Embedding the admin), configuration.md (Configuration), api-routes.md (API Routes), customization.md (Custom Ticket Actions, Custom Store, Ticket Statuses, Priorities, Translations, Configurable ticket access and routing) and newsletters.md. The 13 translations are regenerated from the new README.
@mpge
mpge merged commit cb53098 into main Nov 13, 2026
4 checks passed
@mpge
mpge deleted the docs/readme-redesign branch November 13, 2026 05:47
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