ash/eskit
1
0
Fork 0
Code Issues 25 Pull requests Projects Releases Packages Wiki Activity Actions

Split README (1900 lines) into quick-start + docs/ #73

New issue
Closed
opened 2026-02-22 13:38:53 +00:00 by ash · 0 comments
ash commented 2026-02-22 13:38:53 +00:00
Owner
Copy link

Problem

README.md is 1900 lines. Thats a book. New users bounce.

Fix

  • README: 200 lines max. Quick-start, install, 3 patterns, link to docs/
  • docs/getting-started.md — full tutorial
  • docs/stores.md — backend comparison
  • docs/serialization.md — codec guide
  • docs/middleware.md — logging, metrics, otel
  • docs/advanced.md — snapshots, subscriptions, clustering, GDPR

Acceptance

  • README < 250 lines
  • docs/ has all detailed content
  • Nothing lost, just reorganized
## Problem README.md is 1900 lines. Thats a book. New users bounce. ## Fix - README: 200 lines max. Quick-start, install, 3 patterns, link to docs/ - docs/getting-started.md — full tutorial - docs/stores.md — backend comparison - docs/serialization.md — codec guide - docs/middleware.md — logging, metrics, otel - docs/advanced.md — snapshots, subscriptions, clustering, GDPR ## Acceptance - [ ] README < 250 lines - [ ] docs/ has all detailed content - [ ] Nothing lost, just reorganized
ash closed this issue 2026-02-22 15:08:58 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels   
bug

   
documentation

   
enhancement

   
investigation

   
nice-to-have

   
performance

   
production-ready

   
testing
No labels
bug
documentation
enhancement
investigation
nice-to-have
performance
production-ready
testing
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ash/eskit#73
No description provided.