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

docs: update module usage instructions to remove Grunt and reflect dev-2.0 tooling #7871

Open LalitNarayanYadav opened this issue 6 months ago • 3 comments

Changes:

  • Removed outdated Grunt-based module bundling instructions from the main "Usage" section.
  • Added updated instructions using npm run build for dev-2.0 and guidance on custom builds via Rollup.
  • Moved legacy Grunt commands into a clearly labeled section with a deprecation warning.

Fixes #7871

PR Checklist

LalitNarayanYadav avatar Jun 07 '25 10:06 LalitNarayanYadav

Hi @LalitNarayanYadav thanks for working on this! To link the PR to an issue, please write: "Fixes #7871" (if the issue should be closed when this PR is merged; otherwise, write "Addresses [issue]"). Thank you!

ksen0 avatar Jun 07 '25 11:06 ksen0

Thanks you @ksen0 ! I'll keep it in mind.

LalitNarayanYadav avatar Jun 07 '25 11:06 LalitNarayanYadav

Thanks for the review, @perminder-17!

Yes, I did update some Spanish .md files. I verified the changes using both Google Translate and AI-based translation tools to ensure they align with the English versions. However, since I'm not fluent in Spanish, I'd appreciate it if someone with Spanish proficiency could review those sections for accuracy.

Let me know if you’d prefer I flag these specific files for further review.

LalitNarayanYadav avatar Jun 12 '25 12:06 LalitNarayanYadav

Hi @marioguzzzman, could you take a look at the Spanish files here, and sense-check if they are understandable please? If the PR is merged before you have time to get to it, please feel free to make a new PR with your suggestions! Thank you very much.

ksen0 avatar Sep 16 '25 13:09 ksen0

Hi @LalitNarayanYadav,

Thank you for starting this Spanish translation work! At the same time, I saw some issues.

  1. Translation is based on unmerged content This PR translates from #7871, which is still open and still not merged. We should wait for #7871 to be finalized first to avoid the translation to become messy.

  2. Discrepancies with the English version This is not a comprehensive list as probably we need to wait for a stable version before translating, but I found:

Missing translations:

  • Complete paragraph about p5.js 2.0 no longer using Grunt (npm scripts, ESLint, Vitest)
  • from Main build task section
  • from Link task section
  • from Test task section

Content that doesn't match English:

  • The Spanish version includes a description of npm run build mentioning Vite and custom configurations, but this doesn't appear in the current English version

I would recommend to wait for #7871 to be reviewed and merged first. Then I can work with @LalitNarayanYadav to complete the ungrunting part of the /es/steward_guidelines.md

@ksen0 do you agree with this process?

marioguzzzman avatar Nov 01 '25 10:11 marioguzzzman