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

[PR #1123] Add more documentation #1558

New Issue
Closed
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

Original Pull Request: https://github.com/adamhathcock/sharpcompress/pull/1123

State: closed
Merged: Yes

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.
**Original Pull Request:** https://github.com/adamhathcock/sharpcompress/pull/1123 **State:** closed **Merged:** Yes --- 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.
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#1558
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?