Skip to content

feat: no way to test local docs build of p5.sound.js on the reference page #1224

@kunstewi

Description

@kunstewi

Increasing Access

It would allow future contributors to test the local docs build of p5.sound.js on the reference page.

Most appropriate sub-area of p5.js?

p5.js-website docs parsing script

Feature request details

while working on p5.sound.js codebase I saw no option to test the generated docs locally from a local build of p5.sound.js although dummy console.log was present but no logic.

if (useExternalP5Sound) {
console.log('Cloning separate p5.sound repo');

the logic is present for p5.js builds, we can test local builds of p5.js.

// If we're using a custom build of p5 instead of a public release, create
// a build and copy it to the specified path
if (process.env.PUBLIC_P5_LIBRARY_PATH) {
await createP5Build('p5.js', `../../../public${ process.env.PUBLIC_P5_LIBRARY_PATH}`);
}

it would be a good idea to implement this so in future we could seamlessly test any doc related changes of p5.sound.js on this website.

this targets the 2.0 branch.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions