Skip to content

updates docs for latest changes and ArchiveInfo#1349

Merged
adamhathcock merged 2 commits into
masterfrom
adam/update-docs
Jun 7, 2026
Merged

updates docs for latest changes and ArchiveInfo#1349
adamhathcock merged 2 commits into
masterfrom
adam/update-docs

Conversation

@adamhathcock

Copy link
Copy Markdown
Owner

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.md for 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 CompressionType and ArchiveType values in the API documentation to cover all newly supported formats and compression methods. [1] [2]

Contributor and Maintenance Guidance

  • Added a public API documentation checklist to AGENTS.md to 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

  • Updated references and links in README.md to 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.

Copilot AI review requested due to automatic review settings June 6, 2026 14:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, ArchiveFactory capability 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., in docs/API.md, docs/USAGE.md, and docs/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.

@adamhathcock adamhathcock enabled auto-merge June 7, 2026 10:23
@adamhathcock adamhathcock merged commit 5de1193 into master Jun 7, 2026
6 checks passed
@adamhathcock adamhathcock deleted the adam/update-docs branch June 7, 2026 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants