Reorganize documentation into docs/ directory#68
Merged
Conversation
- Slim down README to focus on quick start and usage example - Move detailed filter documentation to docs/filters.md - Move sort documentation to docs/sorts.md - Add docs/api.md for consumer API reference - Add docs/contributing.md for development setup
|
This PR is stale because it has been open 20 days with no activity. Replace the |
|
This PR was closed because it has been stalled for 5 days with no activity. |
mohanad-toaima
approved these changes
May 11, 2026
andrew-wheeler
approved these changes
May 11, 2026
bunnrf
approved these changes
May 14, 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
5 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.
Summary
This makes the README more approachable for new users while keeping comprehensive documentation available in the docs/ folder.
Test plan