Skip to content

Yoast SEO 28.9 — docs(yoast-seo-abilities): Document term SEO data and author schema abilities - #431

Open
claude[bot] wants to merge 7 commits into
mainfrom
rc-sync/wordpress-seo/28.9-RC1/yoast-seo-abilities
Open

claude[bot] wants to merge 7 commits into
mainfrom
rc-sync/wordpress-seo/28.9-RC1/yoast-seo-abilities

Conversation

@claude

@claude claude Bot commented Oct 28, 2026

Copy link
Copy Markdown

RC docs sync — 28.9-RC1

Product: wordpress-seo
Area: yoast-seo-abilities
Source evidence:

  • src/abilities/user-interface/abilities/get-term-seo-data-ability.php: New yoast-seo/get-term-seo-data ability — reads SEO data for a single taxonomy term
  • src/abilities/user-interface/abilities/update-term-seo-data-ability.php: New yoast-seo/update-term-seo-data ability — updates SEO data for a single taxonomy term
  • src/abilities/user-interface/abilities/update-author-schema-ability.php: New yoast-seo/update-author-schema ability — updates a user's pronouns and social profiles for their Person schema
  • src/abilities/infrastructure/term-seo-field-map.php: Term SEO field definitions (term_id, term_name, permalink, taxonomy, shared SEO fields, canonical, noindex)
  • src/abilities/infrastructure/author-schema-field-map.php: Author schema field definitions (wpseo_pronouns, plus all person social profile fields)

Changes in this PR

  • docs/features/yoast-seo-abilities/terms-seo-data.md — new page documenting get-term-seo-data and update-term-seo-data
  • docs/features/yoast-seo-abilities/author-schema.md — new page documenting update-author-schema
  • docs/features/yoast-seo-abilities/overview.md — updated to list the three new abilities and added links from the Annotations section and Use cases section
  • sidebars.js — added navigation entries for both new pages

Verification

  • yarn build passes locally in this workflow.
  • yarn lint clean for files touched by this PR.

Reviewer notes

  • The wpseo_author_schema_ability_fields filter found in author-schema-field-map.php carries an @internal annotation and is not documented; it is listed in the run summary as internal surface skipped.
  • Term abilities share the same permission model as post abilities (wpseo_edit_advanced_metadata) plus a per-term edit_term check applied inside the ability. This is confirmed by Indexable_Access_Checker.ensure_can_edit().
  • update-author-schema uses a different permission model: edit_user for the target user, not wpseo_edit_advanced_metadata. Documented under Permissions accordingly.
  • The wpseo_pronouns field can only be set when author archives are enabled and the current user can edit other users; the ability returns a warning otherwise. Documented with a note in the Input section.
  • Author schema abilities are public by design (per AGENT_MAP.md yoast-seo-abilities rule) even though they live under src/abilities/user-interface/ — the path heuristic is explicitly exempt for this area.

Authored by the RC docs-sync agent. Not auto-merged — requires human review. Run: https://github.com/Yoast/developer/actions/runs/40643190472

🤖 Generated with Claude Code

…bilities

Adds documentation for three new abilities introduced in Yoast SEO 28.9:
- yoast-seo/get-term-seo-data: read SEO data for a taxonomy term
- yoast-seo/update-term-seo-data: update SEO data for a taxonomy term
- yoast-seo/update-author-schema: update a user's pronouns and social profiles

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added rc-doc-sync RC documentation sync PR product/wordpress-seo Related to Yoast SEO for WordPress area/yoast-seo-abilities rc/28.9-RC1 labels Oct 28, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Deploying yoast-developer with  Cloudflare Pages  Cloudflare Pages

Latest commit: e1fa0f1
Status: ✅  Deploy successful!
Preview URL: https://f4216590.yoast-developer.pages.dev
Branch Preview URL: https://rc-sync-wordpress-seo-28-9-r.yoast-developer.pages.dev

View logs

@leonidasmi leonidasmi self-assigned this Oct 30, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The documentation targets abilities unavailable in the referenced release and inaccurately describes sanitized writes and custom breadcrumb titles.

3 open issues
What changed in this PR

Expands the Yoast SEO Abilities documentation with term SEO data, author schema, and archive and special-page settings, including permissions, request examples, and response schemas.

Changes:

  • Adds three ability reference pages covering inputs, outputs, Premium fields, and programmatic disabling.
  • Connects the new pages through navigation, overview links, and usage examples.
  • Centralizes annotation explanations and clarifies homepage handling in the post SEO documentation.
File Description
sidebars.js Adds navigation entries for the three new pages.
docs/​features/​yoast-seo-abilities/​terms-seo-data.md Documents reading and updating individual terms’ SEO data.
docs/​features/​yoast-seo-abilities/​site-representation.md Links shared annotation guidance and clarifies empty values.
docs/​features/​yoast-seo-abilities/​posts-seo-data.md Clarifies homepage handling and standardizes snippet-variable terminology.
docs/​features/​yoast-seo-abilities/​overview.md Lists additional abilities, links, and use cases.
docs/​features/​yoast-seo-abilities/​feature-toggles.md Streamlines annotation and discovery guidance.
docs/​features/​yoast-seo-abilities/​author-schema.md Documents author schema settings, permissions, and Premium fields.
docs/​features/​yoast-seo-abilities/​archives-and-special-pages-seo-settings.md Documents archive and special-page settings, targets, and responses.
docs/​features/​yoast-seo-abilities/​analysis-scores.md Links centralized discovery guidance and removes repeated explanations.

Review effort: Balanced

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/yoast-seo-abilities product/wordpress-seo Related to Yoast SEO for WordPress rc/28.9-RC1 rc-doc-sync RC documentation sync PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants