docs: sync README/llms.txt/GitHub Pages docs with recent API changes - #3
Merged
Merged
Conversation
… changes README.md, llms.txt, llms-full.txt, and the four GitHub Pages doc pages (API-Reference, Advanced-Features, Getting-Started, index) still documented the old ProbeResult shape (DurationInSeconds/BitsPerSample/ BitRate/SampleRate/Height/Width/Result) and claimed AudioCutter.Cut requires matching source/destination extensions -- both no longer true after the recent ProbeResult redesign and Cut generalization. Update all of them to the current API: the flat ProbeResult with FormatName/ CodecName/DurationSeconds/etc., and Cut's any-source-to-any-dest behavior. Also note WavReader/WavWriter's new 8-bit/32-bit-float PCM support in the API reference.
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
1 participant
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.
Summary
Found and fixed stale documentation across README.md, llms.txt, llms-full.txt, and 4 of the GitHub Pages doc pages (API-Reference, Advanced-Features, Getting-Started, index) — all still described the pre-v3.0.0 API:
ProbeResultshape: docs still showed the oldDurationInSeconds/BitsPerSample/BitRate/SampleRate/Height/Width/Resultfields. Updated to the current flat shape (FormatName,CodecName,DurationSeconds,ChannelLayout,TimeBase, etc.) everywhere it's documented.AudioCutter.Cutbehavior: docs claimed it "requires the source and destination extensions to match" and only listed WAV/FLAC/MP3/AAC. That's no longer true —Cutnow decodes any supported source (including WMA) and writes any supported destination, transcoding while it trims. Fixed in README, llms.txt, llms-full.txt (3 separate mentions), Advanced-Features.html, API-Reference.html, and index.html's feature table.WavReader/WavWriter: added a note about the new 8-bit unsigned and 32-bit PCM/float support in the API reference and llms-full.txt.No code changes — docs/markdown only.
Test plan
DurationInSeconds,matching extensions, oldProbeResultfields) after the edits — none left except legitimate ones on the separateMp3ProbeResult/MovProbeResulttypes, which still genuinely have that field🤖 Generated with Claude Code