Repository navigation
Docs: short README, and a docs tree - #320
Merged
Merged
Conversation
The README now has a filter response plot, one sentence, the two install commands and a Biquad example with its real output. The long README sections become guides (computed audio, Vorbis, filtering, the sampler, the pump, fades, meters, threads) and reference pages, newcomers.md becomes How it works, and the existing explanations move under docs/how-it-works/. Building, testing and releasing go to a new CONTRIBUTING.md. Comments that named the old doc paths now name the new ones.
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
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.
The README is down from 919 lines to the template. It has a frequency-response plot, one sentence, the pip and firmware-build install commands, and an 18-line example that plays sines through a 1 kHz low-pass
Biquad. The example's output (-3.0 dB at 1 kHz, -24.6 at 4 kHz) is copied from a run on CPython withpydevices-audiodsp0.6.10.Where the old material went:
docs/guides/or a reference page underdocs/reference/.newcomers.mdbecamedocs/how-it-works/index.md.audiograph,pump-ports,upstream-diff,upstream-sync,correctness-standardand the wheels page moved intodocs/how-it-works/withgit mv, so their history follows.vorbis.mdmoved intodocs/reference/.CONTRIBUTING.md.Measured figures that couldn't be re-confirmed today were cut, not carried over. These were board timings, benchmark runs and a few counts. Two claims were corrected:
Py_MOD_GIL_NOT_USED.In src, tests and the build files, the only change is the doc paths in comments and one docstring, rewritten to the new locations. No code changed. Every relative link resolves (211 checked).