updates docs for latest changes and ArchiveInfo#1349
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates SharpCompress documentation to reflect expanded format support, new/clarified factory APIs (archive detection, capability probing, multi-volume handling), and updated contributor guidance to keep public docs in sync with API changes.
Changes:
- Updated top-level and contributor docs to list expanded supported formats and updated .NET target frameworks.
- Added/expanded usage and API reference examples for archive detection,
ArchiveFactorycapability probing, multi-volume handling, and typed writer options. - Refreshed format/API matrices and added a public API documentation checklist for contributors.
Review note (needs follow-up):
- The PR title references “ArchiveInfo”, but the docs introduce
ArchiveInformation/GetArchiveInformation(...)terminology (e.g., indocs/API.md,docs/USAGE.md, anddocs/FORMATS.md). This should be made consistent with the actual public API naming to avoid user confusion.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates supported capabilities summary and adds a link to the API reference. |
| docs/USAGE.md | Expands usage guidance with archive auto-detection, capability-based API selection, multi-volume examples, and sequential extraction notes. |
| docs/FORMATS.md | Updates the format support matrix/notes to include new wrapper/stream types and random-access vs reader-only guidance. |
| docs/API.md | Adds and expands API reference examples for detection, options presets, typed writer options, and updated enum/value documentation. |
| AGENTS.md | Updates contributor-facing format/framework guidance and adds a public API documentation checklist. |
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.
This pull request updates the documentation for SharpCompress to reflect expanded format support, enhanced API capabilities, and clarifies usage and compatibility details. The changes improve accuracy, add new examples, and provide clearer guidance for users and contributors.
Key documentation updates:
Expanded Format and Framework Support
Updated all relevant documentation (
AGENTS.md,README.md,docs/FORMATS.md) to include newly supported archive and compression formats: Arc, Arj, Ace, and LZW, as well as new compression methods and legacy/rare formats. Also updated the list of supported .NET target frameworks. [1] [2] [3] [4] [5] [6]Clarified which formats are supported for random-access (Archive API) vs. streaming-only (Reader API), and updated the API and format matrix accordingly. [1] [2]
API and Usage Documentation Improvements
Added new code examples and descriptions in
docs/API.mdfor archive detection, capability probing, multi-volume archive handling, and new reader/writer options. Demonstrated use of typed writer options for ZIP, TAR, GZip, and 7Zip. [1] [2] [3] [4]Expanded the list of
CompressionTypeandArchiveTypevalues in the API documentation to cover all newly supported formats and compression methods. [1] [2]Contributor and Maintenance Guidance
AGENTS.mdto ensure that any changes to public APIs are reflected in the relevant documentation files and that examples remain accurate.Usage and Behavior Clarifications
Clarified extraction patterns for solid Rar and 7Zip archives in
docs/USAGE.md, with improved guidance and new code samples for manual sequential extraction. [1] [2] [3]Clarified TAR and ZIP format-specific behaviors, including compression wrapper support, write support, and ZStandard handling. [1] [2]
Miscellaneous
README.mdto point to the new API reference and reflect the expanded format support.These changes ensure that the documentation remains accurate, comprehensive, and easy to follow for both users and contributors.