starred/sharpcompress
1
0
Fork 0
mirror of https://github.com/adamhathcock/sharpcompress.git synced 2026-02-04 05:25:00 +00:00
Code Issues 975 Packages Projects Releases 20 Wiki Activity

[PR #1123] [MERGED] Add more documentation #1554

New Issue
Open
opened 2026-01-29 22:21:07 +00:00 by claunia · 0 comments
claunia commented 2026-01-29 22:21:07 +00:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/adamhathcock/sharpcompress/pull/1123
Author: @adamhathcock
Created: 1/8/2026
Status: ✅ Merged
Merged: 1/11/2026
Merged by: @adamhathcock

Base: master ← Head: adam/add-more-docs

📝 Commits (5)

  • 8c876c7 Add more documentation
  • 2839e1d Update docs/ENCODING.md
  • 507b1e3 docs: Remove broken references to non-existent files
  • 47037a4 docs: Add explicit guideline that agents should never commit to git
  • b2d1505 remove section on allocations

📊 Changes

9 files changed (+2238 additions, -5 deletions)

View changed files

📝 AGENTS.md (+2 -1)
📝 README.md (+2 -2)
➕ docs/API.md (+489 -0)
➕ docs/ARCHITECTURE.md (+659 -0)
➕ docs/ENCODING.md (+610 -0)
📝 docs/FORMATS.md (+0 -0)
📝 docs/OLD_CHANGELOG.md (+0 -0)
➕ docs/PERFORMANCE.md (+474 -0)
📝 docs/USAGE.md (+2 -2)

📄 Description

This pull request primarily updates documentation to improve clarity and maintain consistency after moving usage documentation into the docs directory. It also adds an important guideline for agents and updates links to reflect the new documentation structure.

Documentation structure and link updates:

  • Updated all references to USAGE.md and FORMATS.md in README.md and AGENTS.md to point to their new locations under the docs/ directory. [1] [2] [3]
  • Renamed USAGE.md to docs/USAGE.md and updated its headings for clarity, including marking async/await support as "Beta" and simplifying the "Stream Rules" section heading. [1] [2]

Agent guidelines:

  • Added a new rule in AGENTS.md stating that agents should never commit to git, but only stage files, leaving commits to the user unless explicitly requested.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/adamhathcock/sharpcompress/pull/1123 **Author:** [@adamhathcock](https://github.com/adamhathcock) **Created:** 1/8/2026 **Status:** ✅ Merged **Merged:** 1/11/2026 **Merged by:** [@adamhathcock](https://github.com/adamhathcock) **Base:** `master` ← **Head:** `adam/add-more-docs` --- ### 📝 Commits (5) - [`8c876c7`](https://github.com/adamhathcock/sharpcompress/commit/8c876c70afdd2caaa62a663b1732a481ce4b67f6) Add more documentation - [`2839e1d`](https://github.com/adamhathcock/sharpcompress/commit/2839e1d33ffbb6ce95e6fcc0ddaa93c951651a0c) Update docs/ENCODING.md - [`507b1e3`](https://github.com/adamhathcock/sharpcompress/commit/507b1e35d8cdf9ed7f29f2949cc0d8826e0ea9a4) docs: Remove broken references to non-existent files - [`47037a4`](https://github.com/adamhathcock/sharpcompress/commit/47037a4b9df0d75913b94f2cb3252977f3f732a7) docs: Add explicit guideline that agents should never commit to git - [`b2d1505`](https://github.com/adamhathcock/sharpcompress/commit/b2d1505e5caa39e7744ba5592b9321ba82efc99e) remove section on allocations ### 📊 Changes **9 files changed** (+2238 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `AGENTS.md` (+2 -1) 📝 `README.md` (+2 -2) ➕ `docs/API.md` (+489 -0) ➕ `docs/ARCHITECTURE.md` (+659 -0) ➕ `docs/ENCODING.md` (+610 -0) 📝 `docs/FORMATS.md` (+0 -0) 📝 `docs/OLD_CHANGELOG.md` (+0 -0) ➕ `docs/PERFORMANCE.md` (+474 -0) 📝 `docs/USAGE.md` (+2 -2) </details> ### 📄 Description This pull request primarily updates documentation to improve clarity and maintain consistency after moving usage documentation into the `docs` directory. It also adds an important guideline for agents and updates links to reflect the new documentation structure. Documentation structure and link updates: * Updated all references to `USAGE.md` and `FORMATS.md` in `README.md` and `AGENTS.md` to point to their new locations under the `docs/` directory. [[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L7-R7) [[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L17-R17) [[3]](diffhunk://#diff-a54ff182c7e8acf56acfd6e4b9c3ff41e2c41a31c9b211b2deb9df75d9a478f9L113-R114) * Renamed `USAGE.md` to `docs/USAGE.md` and updated its headings for clarity, including marking async/await support as "Beta" and simplifying the "Stream Rules" section heading. [[1]](diffhunk://#diff-52296615debf3994195e43d91c94e02bfdc615a27620e0dbc72140b3de98dde1L3-R3) [[2]](diffhunk://#diff-52296615debf3994195e43d91c94e02bfdc615a27620e0dbc72140b3de98dde1L16-R16) Agent guidelines: * Added a new rule in `AGENTS.md` stating that agents should never commit to git, but only stage files, leaving commits to the user unless explicitly requested. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-29 22:21:07 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
duplicate
enhancement
feedback requested
not bug
pull-request
Mirrored from GitHub Pull Request
 question
up for grabs
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/sharpcompress#1554
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?