Yoast / Yoast/developer

RC docs-sync audit log — Yoast SEO

Open
#390 37 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
15
Forks
23
PR merge metrics
No merged PRs in 30d

Description

RC docs-sync — Yoast SEO

This is the audit log for the RC docs-sync workflow running on Yoast SEO (free, Yoast/wordpress-seo).

The workflow runs daily at 06:00 UTC. For every new RC tag in the source repo, it analyzes the diff against the last processed release, decides whether the developer-portal docs need updating, and — when warranted — opens one draft PR per affected feature area. Every run posts one comment to this issue, regardless of whether any PRs were opened, so this thread is the canonical record of what was checked and when.

How to read the comments

Every comment starts with a machine-readable marker. The workflow uses these markers to determine which RCs have already been processed — please do not edit or delete comments that contain a marker, otherwise the next run may re-process or skip RCs.

<!-- rc-docs-sync:v1 product=wordpress-seo rc_tag=27.5-RC1 -->

After the marker, the comment body falls into one of these shapes:

  • No-op run"no doc changes needed". The RC contained only tests, translations, lockfile bumps, or internal refactors with no public-surface impact. The marker is posted; no PR is opened.
  • PR-producing run — lists the PRs opened, with links and brief rationales. Each PR's title is Yoast SEO <base-version> — docs(<area>): <title>.
  • Coverage gaps observed — if the agent saw new public surface (a new filter, REST route, or top-level src/<subsystem>/) that doesn't match any area in AGENT_MAP.md, it lists them under that heading. Informational only; updating the map is a separate manual PR.

Find the PRs

Filter by labels: rc-doc-sync + product/wordpress-seo.

https://github.com/Yoast/developer/pulls?q=is%3Apr+label%3Arc-doc-sync+label%3Aproduct%2Fwordpress-seo

Backfill a specific past RC

Run the RC docs sync workflow manually via "Run workflow" with product=wordpress-seo and the RC tag you want to backfill.

Pause / disable

Comment out the schedule: trigger in the workflow YAML, or remove the wordpress-seo entry from the PRODUCTS dict at the top of the workflow's resolve-queue step.

Related artifacts

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with .github/workflows/rc-docs-sync.yml, then read .github/claude-agent/run.md and AGENT_MAP.md. This issue is an automated audit log and does not identify a documentation change or other concrete contribution; the workflow comments and related PRs describe its current activity.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.