p5.sound.js icon indicating copy to clipboard operation
p5.sound.js copied to clipboard

Links to source code in reference documents go to the wrong repository, throws error 404.

Open Metamere opened this issue 1 year ago • 2 comments

On the reference pages such as https://p5js.org/reference/p5.sound/p5.Noise/, there is a blurb at the bottom as follows:

Notice any errors or typos? Please let us know. Please feel free to edit src/Noise.js and open a pull request!

But there is no such file, and it displays an error 404, so this would likely lead to confusion. It seems like there are similar incorrect links in many of the p5.sound reference files, including:

https://p5js.org/reference/p5.sound/p5.Amplitude/ https://p5js.org/reference/p5.sound/p5.AudioIn/ https://p5js.org/reference/p5.sound/p5.Biquad/ https://p5js.org/reference/p5.sound/p5.Delay/ https://p5js.org/reference/p5.sound/p5.Envelope/ https://p5js.org/reference/p5.sound/p5.FFT/ https://p5js.org/reference/p5.sound/p5.Gain/ https://p5js.org/reference/p5.sound/p5.Noise/ https://p5js.org/reference/p5.sound/p5.Oscillator/ https://p5js.org/reference/p5.sound/p5.Panner/ https://p5js.org/reference/p5.sound/p5.Panner3D/ https://p5js.org/reference/p5.sound/p5.PitchShifter/ https://p5js.org/reference/p5.sound/p5.Reverb/ https://p5js.org/reference/p5.sound/p5.SawOsc/ https://p5js.org/reference/p5.sound/p5.SinOsc/ https://p5js.org/reference/p5.sound/p5.SqrOsc/ https://p5js.org/reference/p5.sound/p5.TriOsc/

Many of the methods for these also have broken links.

Here is an example image Example image

Metamere avatar Dec 10 '24 19:12 Metamere

@davepagurek @limzykenneth

ogbabydiesal avatar Dec 11 '24 06:12 ogbabydiesal

There's a related issue open for the p5 website repo here for the first part of this issue: https://github.com/processing/p5.js-website/issues/636

Probably the fix will be in that repo.

For the latter, we could potentially address that in either spot, but using absolute links in this repo could work.

davepagurek avatar Dec 11 '24 12:12 davepagurek

Hi all! I just checked a few of the pages above, and they all have working links now. The matching issues/PRs in the website repository have been merged, so this should be fixed. The intended behavior is that the former p5.sound.js (bundled with 1.x is on p5js.org; and this new addon is on beta.p5js.org. Please feel free to open if you find that this issue is actually not resolved!

ksen0 avatar Jun 10 '25 14:06 ksen0