Repository navigation
doc: add README - #3
Merged
Merged
Conversation
|
yes, even if it's just a "install and here will be your collection's new super-powers". Thx. |
Also refreshes the `composer.json` description/keywords and fixes `suggest` entries that referenced classes which don't exist.
bocharsky-bw
approved these changes
Aug 19, 2026
bocharsky-bw
left a comment
bocharsky-bw
left a comment
There was a problem hiding this comment.
This package definitely needed docs, and this PR adds a decent amount of docs! That's a great start 👍🏼
This was referenced Aug 19, 2026
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
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.
The package has no documentation, so this adds a full README: the
CollectionAPI and its implementations, pagination, the Doctrine integrations (EntityResult, repositories, batch processing, thedoctrine/collectionsbridge and specifications), the Symfony bundle and static analysis.Grid is intentionally left out - it's the least settled part of the API and deserves its own pass.
Also refreshes the
composer.jsondescription/keywords and fixes thesuggestentries: two referenced classes that don't exist (CollectionDecorator,CollectionAdapter), andsymfony/expression-language,zenstruck/urianddoctrine/doctrine-bundlewere missing despite hard-failing when absent.