Split README into user and developer guides#59
Merged
Conversation
- Refactored README.md to focus on library users with: - Clear features section highlighting key capabilities - Improved structure and readability - Added comprehensive Aggregations section - Enhanced code examples throughout - Added Contributing and License sections - Created CONTRIBUTING.md for developers with: - Complete development setup instructions - Monorepo structure and workflow details - Code style guidelines and conventions - Key design patterns and TypeScript techniques - Testing guidelines and examples - Pull request process This separation provides clear, purpose-driven documentation for both user and contributor audiences.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Artmann
deleted the
claude/split-readme-guides-018zusTvtMTxnenMSAc51gvt
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refactored README.md to focus on library users with:
Created CONTRIBUTING.md for developers with:
This separation provides clear, purpose-driven documentation for both user and contributor audiences.