626 create the feature opt in in the yoast dashboard by vraja-pro · Pull Request #22425 · Yoast/wordpress-seo

vraja-pro · 2025-07-11T14:06:11Z

Context

Summary

This PR can be summarized in the following changelog entry:

Adds the llm txt opt in.

Relevant technical choices:

I decided to save the user meta in a separate meta key and not use the introductions because it is not an introduction modal, and because it's being dismissed immediately on retrieval.
Used a the browser cache (sessionStorage) for the popover trigger. Its cleaner than the adding an argument to the url.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Go to general page, check you see the a notification on the bottom left for the llm txt feature:

Click on on the Show me button and see you are redirected to the right settings with a popover with backdrop:

Dismiss the popover and refresh
Check the popover doesn't reappear.
Go back to the general page and check you don't see the notification.
Reset the user meta wpseo_seen_llm_txt_opt_in_notification
Go to general page and check you see the notification again.
Dismiss and refresh, check you don't see the notification.
Reset the user meta again.
Go to general page and check you see the notification again.
Refresh, check you don't see the notification.
Reset the user meta again
Go to the llms.txt settings page and enable the feature
Go to the general page and check you don't see the notification.
Disable the feature.
Log in as a different user and go to the general page
Check you see the notification and click on show me
Check you see the popover in the settings as expected.
Go back to the general page and check you no longer see the notification.

If local/session storage is disabled in the browser:

to make sure things still work even if local/session storage is disabled in the browser, let's use Firefox for this ((because it has a way to disable local storage without disabling cookies).
Type about:config in the address bar to view advanced settings (you may need to click an "Accept the Risk and Continue" button in order to view settings).
Search for "dom.storage.enabled", and double-click on the entry (or use the adjacent toggle button) to toggle its enabled (true) or disabled (false) state.
Reset the user meta wpseo_seen_llm_txt_opt_in_notification and refresh the general page.
Check you don't get the opt in notification.
Go to the lm.txt setting and check you don't get the popover.
IMPORTANT: Make sure you revert the dom.storage.enabled preference to true because if you don't, your Firefox will not work properly in the future.

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:

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 Create the feature opt-in in the Yoast dashboard

To avoid retrigering the optin

coveralls · 2025-07-13T18:25:58Z

Pull Request Test Coverage Report for Build 0c51e5563c15377321089baa91534f0444509a4a

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

16 of 47 (34.04%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.03%) to 53.638%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
packages/js/src/settings/routes/llms-txt.js	0	1	0.0%
packages/js/src/general/components/llm-txt-opt-in-notification.js	1	14	7.14%
packages/js/src/settings/components/llm-txt-popover.js	0	17	0.0%

Totals
Change from base Build a2bd7e124e8fda2c486937b59f8a306770f2e0af:	-0.03%
Covered Lines:	30565
Relevant Lines:	57972

💛 - Coveralls

leonidasmi

CR: 🏗️

leonidasmi · 2025-07-14T07:37:24Z

+export const LlmTxtOptInNotification = () => {
+	const svgAriaProps = useSvgAria();
+	const llmTxtSettingsUrl = useSelectGeneralPage( "selectAdminLink", [],  "?page=wpseo_page_settings#/llms-txt" );
+	sessionStorage.setItem( "highlight-setting", "llm-txt" );


Have we considered other alternatives to achieve what we want? I'm kind of hesitant to introduce using session storage in our code base (aside from some usage we got from a library) unless it's necessary.

With using session storage, I think we need to consider many more aspects than what we currently do, like:

most importantly, we need to give the key a yoast-specific name, to avoid conflicts with third parties, so something like yoast-highlight-setting

I think we need to consider cases where session storage is disabled in the user's browser. I'm not sure if defensive coding is needed, but we need to at least test that the feature might not work in those cases but it fails gracefully.

There's some examples on how to fail that in the test instructions of this PR.

at the very least, using session storage deserves its own technical decision in the PR.

leonidasmi · 2025-07-14T08:38:07Z

By the way, although it's more of an acceptance thing, the styling of the popover is quite different from the desings, mostly about margins:

Co-authored-by: Leonidas Milosis <leonidas.milossis@gmail.com>

don't show the the notification if session storage is disabled

leonidasmi

CR + Acceptance is ✅

vraja-pro added 2 commits July 11, 2025 16:55

add opt in popover

963a0cd

add notification for the general page

d9ed696

vraja-pro added this to the feature/llms-txt-phase-2 milestone Jul 11, 2025

vraja-pro added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jul 11, 2025

vraja-pro added 4 commits July 11, 2025 17:09

remove url args

814950a

To avoid retrigering the optin

rename user meta

1a006c1

use browser cache for llm txt opt in

18e9b2b

fix tests

81f2877

vraja-pro force-pushed the 626-create-the-feature-opt-in-in-the-yoast-dashboard branch from fc01cd5 to 81f2877 Compare July 13, 2025 18:23

vraja-pro added 2 commits July 14, 2025 10:11

add cache after user click show me

e2ae484

update warnings threshold

f0b39f8

leonidasmi reviewed Jul 14, 2025

View reviewed changes

vraja-pro and others added 4 commits July 14, 2025 13:52

Update src/general/user-interface/general-page-integration.php

31aa92b

Co-authored-by: Leonidas Milosis <leonidas.milossis@gmail.com>

check for cache only on first render

c62c1fc

fix notification transition and condition

2e5d040

fix translation

d1b6321

Base automatically changed from feature/llms-txt-phase-2 to trunk July 14, 2025 14:01

vraja-pro added 4 commits July 15, 2025 10:53

fix styling and use hooks

28c55cb

Add a todo comment

c06fa1b

add yoast key sessionStorage

c3bad25

Adds covers annotation

3cc446c

vraja-pro force-pushed the 626-create-the-feature-opt-in-in-the-yoast-dashboard branch from 5079c58 to 3cc446c Compare July 15, 2025 08:05

leonidasmi reviewed Jul 15, 2025

View reviewed changes

Comment thread packages/js/src/settings/routes/llms-txt.js Outdated

Update packages/js/src/settings/routes/llms-txt.js

f5bf8da

Co-authored-by: Leonidas Milosis <leonidas.milossis@gmail.com>

leonidasmi reviewed Jul 15, 2025

View reviewed changes

Comment thread packages/js/src/settings/components/llm-txt-popover.js Outdated

vraja-pro added 2 commits July 15, 2025 11:47

incase sessionStorage is disabled

6b93de6

don't show the the notification if session storage is disabled

no need for toggle

4e00cb3

leonidasmi removed this from the feature/llms-txt-phase-2 milestone Jul 15, 2025

leonidasmi modified the milestones: 25.7, 25.6 Jul 15, 2025

leonidasmi approved these changes Jul 15, 2025

View reviewed changes

leonidasmi merged commit 79fda9f into trunk Jul 15, 2025
54 of 55 checks passed

leonidasmi deleted the 626-create-the-feature-opt-in-in-the-yoast-dashboard branch July 15, 2025 09:17

leonidasmi mentioned this pull request Jul 15, 2025

llms.txt Phase 2 #22428

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

626 create the feature opt in in the yoast dashboard#22425

626 create the feature opt in in the yoast dashboard#22425
leonidasmi merged 19 commits intotrunkfrom
626-create-the-feature-opt-in-in-the-yoast-dashboard

vraja-pro commented Jul 11, 2025 •

edited

Loading

Uh oh!

coveralls commented Jul 13, 2025 •

edited

Loading

Uh oh!

leonidasmi left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

leonidasmi Jul 14, 2025

Uh oh!

Uh oh!

Uh oh!

leonidasmi commented Jul 14, 2025

Uh oh!

Uh oh!

Uh oh!

leonidasmi left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

vraja-pro commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Summary

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

Relevant test scenarios

Test instructions for QA when the code is in the RC

Impact check

UI changes

Other environments

Documentation

Quality assurance

Innovation

Uh oh!

coveralls commented Jul 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 0c51e5563c15377321089baa91534f0444509a4a

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

leonidasmi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

leonidasmi Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

leonidasmi commented Jul 14, 2025

Uh oh!

Uh oh!

Uh oh!

leonidasmi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vraja-pro commented Jul 11, 2025 •

edited

Loading

coveralls commented Jul 13, 2025 •

edited

Loading