Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes documentation by moving version history to a dedicated changelog file, simplifying code examples, and updating cross-references. The main goals are to clean up the README.md and streamline the USAGE.md examples.
- Moved extensive version history from README.md to a new OLD_CHANGELOG.md file
- Simplified the progress reporting example in USAGE.md to use built-in Progress support
- Updated the async documentation reference in README.md to point to USAGE.md
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| USAGE.md | Simplified progress reporting example to use ReaderOptions with Progress instead of manual progress tracking |
| README.md | Removed async examples and version history sections, updated link to async documentation, minor heading corruption issue |
| OLD_CHANGELOG.md | New file containing version history moved from README.md |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Jan 7, 2026
This was referenced Jan 19, 2026
This was referenced Jan 26, 2026
This was referenced Feb 12, 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
1 participant
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.
Moved some things around and added a little