processing / p5.js-website

New p5.js website!
http://p5js.org
MIT License
18 stars 92 forks source link

Easy way to preview unreleased reference changes on the p5.js repo #474

Open davepagurek opened 3 months ago

davepagurek commented 3 months ago

Increasing Access

Currently, in the p5.js repo, I write documentation by editing the doc comments in the code and running grunt yui:dev, which launches a local miniature version of the reference. This still works, but uses the CSS from the old site. This is still useful, but it would be great if there were an easy way to preview changes on the new site to get a better sense of how everything will look, rather than having to guess, and possibly correcting it in a future release, which can take months.

Most appropriate sub-area of p5.js?

Reference

Feature request details

Currently it clones a library repo fresh here: https://github.com/processing/p5.js-website/blob/9ea8b7419aaaf083fc60785a8cc30060a4b7f194/src/scripts/parsers/reference.ts#L20

Maybe we can augment this to optionally build reference data from an existing local repo?