Skip to content

Update Single title assessment documentation#22936

Open
agnieszkaszuba wants to merge 1 commit intotrunkfrom
update-single-title-assessment-documentation
Open

Update Single title assessment documentation#22936
agnieszkaszuba wants to merge 1 commit intotrunkfrom
update-single-title-assessment-documentation

Conversation

@agnieszkaszuba
Copy link
Contributor

@agnieszkaszuba agnieszkaszuba commented Feb 2, 2026

Context

  • In Google Docs, an H1 at the top of the document is treated as the title, which affects the single title assessment criteria.
  • The single title assessment is always applicable since the off-the-bat project.

Summary

This PR can be summarized in the following changelog entry:

  • Updates the single title assessment documentation.
  • [yoastseo] Updates the single title assessment documentation.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • No testing needed, only documentation was updated.

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:

Impact check

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

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.
  • This PR also affects Yoast SEO for Google Docs. I have added a changelog entry starting with [yoast-doc-extension], added test instructions for Yoast SEO for Google Docs and attached the Google Docs Add-on 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.
  • I have run grunt build:images and commited the results, if my PR introduces new images or SVGs.

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 https://github.com/Yoast/reserved-tasks/issues/920

@agnieszkaszuba agnieszkaszuba added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Feb 2, 2026
@agnieszkaszuba agnieszkaszuba changed the title Updates Single title assessment documentation Update Single title assessment documentation Feb 2, 2026
@coveralls
Copy link

Pull Request Test Coverage Report for Build 3c11b3766fb953a4aa90347d93ba40e942669973

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.5%) to 53.445%

Totals Coverage Status
Change from base Build d281424328327dd77aa852400e5b9729c7c5261c: 0.5%
Covered Lines: 33044
Relevant Lines: 61998

💛 - Coveralls

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.

2 participants