WordPress / WordPress/block-development-examples

_data metadata gaps: untagged examples, undefined/unused tags, stale "experimental" labels

Open
#152 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
334
Forks
52
PR merge metrics
No merged PRs in 30d

Description

Problem

_data/examples.json and _data/tags.json drive the README table and the web app's tag navigation, and they've drifted:

  • 4 examples have empty tags (required per _data/README.md), making them invisible to anyone browsing by tag: editable-block-1b8c51, inner-blocks-dcd824, recipe-card-744e8a, settings-sidebar-82c525.
  • 2 tags are used in examples.json but undefined in tags.json: block and experimental — their filter links in the web app lead nowhere useful.
  • 1 tag is defined but never used: gutenberg-plugin.
  • Stale stability labels: experimental is applied to the Interactivity API countdown, and several tags.json descriptions still call the Interactivity API experimental — it has been stable in core since WP 6.5.
Proposed fix
  1. Tag the 4 untagged examples (proposals — maintainer-reviewable):
    • inner-blocks-dcd824 → new tag inner-blocks + static-rendering
    • editable-block-1b8c51static-rendering (covers its build and no-build editable blocks)
    • recipe-card-744e8astatic-rendering
    • settings-sidebar-82c525 → new tag inspector-controls (nothing in the current vocabulary covers block settings sidebars)
  2. Delete the experimental tag from examples.json and remove the generic block tag (too broad to filter on) — or define them if there's a reason to keep them.
  3. Remove or use gutenberg-plugin (currently dead weight; likely removable once Gutenberg leaves the wp-env setup, see #151).
  4. Reword tags.json descriptions that still call the Interactivity API experimental.
  5. Add a _data validation step to CI (in static-linting.yml, via the existing _bin tooling): every used tag is defined, every example has ≥1 tag, no defined tag is orphaned, every examples.json slug has a matching plugins/ dir and vice versa. This is what prevents this issue from recurring.
  6. Run npm run table:update to regenerate the README table.
Out of scope
  • Plugin code/header changes (#150) and wp-env changes (#151).

Contributor guide

No contributing guide indexed for this repository

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 _data/README.md, _data/examples.json, and _data/tags.json to verify the metadata requirements and proposed tag changes. Then inspect the existing _bin tooling and static-linting.yml before adding the validation step, and run npm run table:update. Done means the metadata is consistent, the validation covers the listed invariants, and the README table is regenerated.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
ci-cd, documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.