Skip to content

docs(seo): clarify the SEO panel is only honored if the page wires getSeoMeta#1519

Open
DavidPivert wants to merge 2 commits into
emdash-cms:mainfrom
DavidPivert:docs/seo-panel-honored-on-all-pages
Open

docs(seo): clarify the SEO panel is only honored if the page wires getSeoMeta#1519
DavidPivert wants to merge 2 commits into
emdash-cms:mainfrom
DavidPivert:docs/seo-panel-honored-on-all-pages

Conversation

@DavidPivert

@DavidPivert DavidPivert commented Jun 17, 2026

Copy link
Copy Markdown

What does this PR do?

Adds a prominent gotcha + a "composing panel overrides with custom defaults" snippet to the SEO section of skills/building-emdash-site/references/site-features.md.

The admin SEO panel (SEO title, meta description, OG image, canonical, noindex) lives on entry.data.seo and has no effect unless the page calls getSeoMeta/getContentSeo. The current docs only demonstrate this for a posts page and never warn that hand-written <title>{entry.data.title}</title> silently bypasses the whole panel — including the noindex toggle. This is easy to hit on real sites (no error, no warning).

Changes:

  • ## SEO Meta: add an [!IMPORTANT] callout that the panel is only honored if the page reads it, and that every content detail page must wire it.
  • New subsection "Composing panel overrides with custom defaults": since getSeoMeta only falls back to data.title/data.excerpt, show how to use getContentSeo to let the panel take precedence over a page's computed title/description.

Docs-only. The same skill is vendored under templates/*/.agents/skills/...; left to whatever sync process keeps them in step with skills/ — happy to update those too if maintained by hand.

Refs #1518

Type of change

  • Bug fix
  • Feature (requires maintainer-approved Discussion)
  • Refactor (no behavior change)
  • Translation
  • Documentation
  • Performance improvement
  • Tests
  • Chore (dependencies, CI, tooling)

Checklist

  • I have read CONTRIBUTING.md
  • pnpm typecheck passes — N/A (docs-only, no code changed); CI Typecheck is green
  • pnpm lint passes — N/A (docs-only)
  • pnpm test passes (or targeted tests for my change) — N/A (docs-only)
  • pnpm format has been run — N/A (markdown only)
  • I have added/updated tests for my changes (if applicable) — N/A
  • User-visible strings in the admin UI are wrapped for translation (if applicable) — N/A
  • I have added a changeset (if this PR changes a published package) — N/A (docs only, no published package changed)
  • New features link to an approved Discussion — N/A (not a feature)

AI-generated code disclosure

  • This PR includes AI-generated code — model/tool: Claude Opus 4.8 (Claude Code)

Screenshots / test output

N/A — documentation change. See #1518 for the motivating real-world case.

@changeset-bot

changeset-bot Bot commented Jun 17, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 7b7239e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added review/needs-review No maintainer or bot review yet size/S labels Jun 17, 2026
@github-actions

github-actions Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@pkg-pr-new

pkg-pr-new Bot commented Jun 17, 2026

Copy link
Copy Markdown

Open in StackBlitz

@emdash-cms/admin

npm i https://pkg.pr.new/@emdash-cms/admin@1519

@emdash-cms/auth

npm i https://pkg.pr.new/@emdash-cms/auth@1519

@emdash-cms/auth-atproto

npm i https://pkg.pr.new/@emdash-cms/auth-atproto@1519

@emdash-cms/blocks

npm i https://pkg.pr.new/@emdash-cms/blocks@1519

@emdash-cms/cloudflare

npm i https://pkg.pr.new/@emdash-cms/cloudflare@1519

@emdash-cms/contentful-to-portable-text

npm i https://pkg.pr.new/@emdash-cms/contentful-to-portable-text@1519

emdash

npm i https://pkg.pr.new/emdash@1519

create-emdash

npm i https://pkg.pr.new/create-emdash@1519

@emdash-cms/gutenberg-to-portable-text

npm i https://pkg.pr.new/@emdash-cms/gutenberg-to-portable-text@1519

@emdash-cms/plugin-cli

npm i https://pkg.pr.new/@emdash-cms/plugin-cli@1519

@emdash-cms/plugin-types

npm i https://pkg.pr.new/@emdash-cms/plugin-types@1519

@emdash-cms/registry-client

npm i https://pkg.pr.new/@emdash-cms/registry-client@1519

@emdash-cms/registry-lexicons

npm i https://pkg.pr.new/@emdash-cms/registry-lexicons@1519

@emdash-cms/sandbox-workerd

npm i https://pkg.pr.new/@emdash-cms/sandbox-workerd@1519

@emdash-cms/x402

npm i https://pkg.pr.new/@emdash-cms/x402@1519

@emdash-cms/plugin-ai-moderation

npm i https://pkg.pr.new/@emdash-cms/plugin-ai-moderation@1519

@emdash-cms/plugin-atproto

npm i https://pkg.pr.new/@emdash-cms/plugin-atproto@1519

@emdash-cms/plugin-audit-log

npm i https://pkg.pr.new/@emdash-cms/plugin-audit-log@1519

@emdash-cms/plugin-color

npm i https://pkg.pr.new/@emdash-cms/plugin-color@1519

@emdash-cms/plugin-embeds

npm i https://pkg.pr.new/@emdash-cms/plugin-embeds@1519

@emdash-cms/plugin-field-kit

npm i https://pkg.pr.new/@emdash-cms/plugin-field-kit@1519

@emdash-cms/plugin-forms

npm i https://pkg.pr.new/@emdash-cms/plugin-forms@1519

@emdash-cms/plugin-webhook-notifier

npm i https://pkg.pr.new/@emdash-cms/plugin-webhook-notifier@1519

commit: 9e7d243

@DavidPivert

Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Jun 17, 2026
@DavidPivert

Copy link
Copy Markdown
Author

recheck

@DavidPivert

Copy link
Copy Markdown
Author

Heads-up for a maintainer on the red checks — none are caused by this PR:

  • This is a docs-only change (one Markdown file, skills/building-emdash-site/references/site-features.md), so it can't affect runtime behaviour or E2E.
  • E2E Tests (required) is red only because it aggregates the shards, and shard 4/8 had 1 failed / 33 passed: invite-flow"invited user appears in the users list" — a toBeVisible timeout unrelated to this change (looks flaky). A re-run should clear it.
  • CLA Assistant / label fails on the "Label CLA status" step — a pull_request_target label write that lacks permissions from a fork. The CLA itself is signed (the CLAssistant check is green).

As a fork contributor I can't re-run Actions — happy for a maintainer to re-run the E2E shard whenever convenient. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: signed review/needs-review No maintainer or bot review yet size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant