docs: Add zstd warning and compression guide with worked examples#2
Conversation
Signed-off-by: promptless-for-oss <promptless-for-oss@users.noreply.github.com>
| @@ -0,0 +1,99 @@ | |||
| # Compression | |||
There was a problem hiding this comment.
Citation: Created new compression guide in response to issue requesting worked examples for compression format usage. Added the table of supported formats with zstd marked as not working yet, plus complete gzip workflow examples.
View source
| While the core design keeps things simple and readable, the tool does work with compressed archives as a practical concession for those who need it. You can read from and write to gzip, deflate, zlib, brotli, and zstd compressed files without special flags. | ||
| While the core design keeps things simple and readable, the tool does work with compressed archives as a practical concession for those who need it. You can read from and write to gzip, deflate, zlib, and brotli compressed files without special flags. | ||
|
|
||
| **⚠️ Note:** zstd support is planned but not yet implemented. Use one of the other compression formats for now. |
There was a problem hiding this comment.
Citation: Added zstd warning per issue report that zstd is not working yet. Also removed zstd from the list of working compression formats and linked to the new compression guide.
View source
There was a problem hiding this comment.
@promptless-for-oss Can you say that zstd support is partially implemented in the code but not functioning. As in the zstd library is in the binary but not wired up to the command line parsing. basically the zstd does not really have a standard extension, so I have not decided what the auto detection should be or if there should be a flag to set the format to zstd.
|
@InlinePizza ✅ Promptless drafted a docs update: #2 |
2 participants
Addresses GitHub issue #1. Adds a note that zstd compression is not yet working, creates a new compression guide page with worked gzip examples, and adds a compression section to the demo README. The changes include:
docs/compression-guide.mdwith complete worked examples showing how to create, append to, and inspect compressed archivesdocs/demo/README.mddemonstrating usage with the existing demo filesTrigger Events
peoplesgrocers/json-archive#1
Promptless Research (1 GitHub Issue)
Agent Response
Tip: This PR was generated by Promptless via Hacker News. Book a demo to learn how Promptless can keep your docs in sync automatically 📅