Only use old p5.sound on 1.x #737
Open
Conversation
This file contains 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
This was referenced Mar 28, 2025
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.
On the current website, we accidentally have a mix of the old p5.sound + the new p5.sound docs. This is because in October we started adding the new sound docs to the reference, but the old sound docs are embedded in the p5 1.x source code, so they continued to get parsed too, leading to broken docs.
For 2.0, we're planning on having a separate site where all 2.0 reference and resources will live. This will be deployed from a separate branch of this repo, and also a separate branch of the p5 repo using something like the
npm run custom:devcommand where you pass in a repo + branch name. This PR makes it so the 2.0 deploy (which no longer has the p5.sound content embedded in the source code) will continue to add the new p5.sound docs to the build, and the 1.x deploy will not, including only the old p5.sound docs already embedded in those p5.js releases.In addition to those changes, this PR also includes the result of running
npm run build:referenceon 1.11.3. This means that APIs that only exist in the new p5.sound get removed, and the reference for APIs that previously existed in both the old and the new p5.sound are reverted to the docs included in the old p5.sound.There are also a few other changes I noticed from
npm run build:reference; maybe we didn't run it before on 1.11.3? So there are a few minor other docs changes, such as fixed typos.