Skip to content

Improve doc about JS build / add more watch scripts#22501

Merged
thijsoo merged 1 commit intotrunkfrom
improve-js-docs
Aug 18, 2025
Merged

Improve doc about JS build / add more watch scripts#22501
thijsoo merged 1 commit intotrunkfrom
improve-js-docs

Conversation

@igorschoester
Copy link
Copy Markdown
Contributor

Context

Summary

This PR can be summarized in the following changelog entry:

  • Improves our documentation a bit.

Relevant technical choices:

  • Add watch commands in the packages that support it
  • Fix URL to Free repo
    Note: the CSS watch in components is not how we use the CSS at all
    Note: I skipped a JSON watch of the style-guide, deprecated package anyway

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Does the documentation make sense?
  • Does everything still work?
  • Do the new commands work?

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

  • Tooling/readme

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #

* Add watch commands in the packages that support it
* Fix URL to Free repo
Note: the CSS watch in components is not how we use the CSS at all
Note: I skipped a JSON watch of the style-guide, deprecated package anyway
@igorschoester igorschoester requested a review from a team as a code owner August 14, 2025 11:36
@igorschoester igorschoester added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Aug 14, 2025
@github-actions
Copy link
Copy Markdown

@igorschoester Please be aware that following packages have been abandoned and are not actively maintained anymore:

Package name Path
@yoast/babel-preset packages/babel-preset
@yoast/components packages/components
@yoast/e2e-tests packages/e2e-tests
@yoast/helpers packages/helpers
@yoast/jest-preset packages/jest-preset
@yoast/style-guide packages/style-guide
eslint-config-yoast packages/esling-config-yoast

Please consider using the other packages instead.

@igorschoester igorschoester changed the title Improve doc about JS build Improve doc about JS build / add more watch scripts Aug 14, 2025
@thijsoo thijsoo self-assigned this Aug 18, 2025
Copy link
Copy Markdown
Contributor

@thijsoo thijsoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CR + ACC 👍

@thijsoo thijsoo added this to the 25.9 milestone Aug 18, 2025
@thijsoo thijsoo merged commit 2efdf67 into trunk Aug 18, 2025
21 of 47 checks passed
@thijsoo thijsoo deleted the improve-js-docs branch August 18, 2025 08:21
@enricobattocchi enricobattocchi added this to the 25.9 milestone Aug 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants