Skip to content

Move site-wide SEO keywords into Docusaurus config - #541

Merged
JoeKarow merged 4 commits into
mainfrom
site-wide-seo-keywords
Oct 7, 2026
Merged

JoeKarow merged 4 commits into
mainfrom
site-wide-seo-keywords

Conversation

@JoeKarow

@JoeKarow JoeKarow commented Oct 7, 2026 •

Copy link
Copy Markdown
Member

Linked Issue

None.

Description

  • docusaurus.config.ts: declares 11 site-wide keywords that describe the whole site.
    • themeConfig.metadata emits them on pages without keywords front matter.
    • A markdown.parseFrontMatter hook adds them in front of any doc's own keywords (duplicates removed), so page terms are added to the site list instead of replacing it.
  • Removes the 24-line keywords: block that had been copied into 97 docs' front matter (2,437 lines deleted).
  • Three docs had their own lists. Each now keeps only its page-specific terms:
    • community-roles/maintainers.md keeps virtual coffee maintainers.
    • lightning-talks/2023/speaker-info.md keeps its lightning-talk phrases.
    • docs/README.md had no unique terms, so its list is gone.
  • CONTRIBUTING.md: adds one line explaining where site keywords live.

Checked in the build output: all 113 generated pages have exactly one <meta name="keywords"> tag, and the two pages with their own terms show the site terms followed by theirs. pnpm check, lint:md, typecheck and build all pass.

Methodology

Every new page was copying the old block, and it labelled unrelated pages with section terms. For example, the Pairing challenge page claimed "coffee table groups" and "lightning talk". With one site-wide list, the site keywords are edited in one place. A page lists keywords only when it has terms of its own, and the build adds the site terms to them, so adding a page-specific term never drops the site list.

Code of Conduct

By submitting this pull request, you agree to follow our Code of Conduct

97 docs carried the same 24-line keywords block, now replaced by the
site-wide default in docusaurus.config.ts. The three docs with their own
lists keep only their page-specific terms (docs/README.md had none).
@JoeKarow
JoeKarow requested review from a team as code owners October 7, 2026 01:07
@netlify

netlify Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for vc-community-docs ready!

Name Link
🔨 Latest commit b795fe3
🔍 Latest deploy log https://app.netlify.com/projects/vc-community-docs/deploys/6ac5ba0c2f7915000863cfe7
😎 Deploy Preview https://deploy-preview-541--vc-community-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 98 (🔴 down 2 from production)
Accessibility: 98 (no change from production)
Best Practices: 100 (no change from production)
SEO: 96 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@greptile-apps

greptile-apps Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[Low risk] Removes duplicate SEO keywords from documentation files.

The PR appears safe to merge; no actionable new issues were found.

What we checked:

  • Page terms remain included: Both pages with their own keywords use arrays. The callback combines those arrays with siteKeywords rather than dropping their terms.

Summary

Moves shared SEO keywords into docusaurus.config.ts and removes repeated lists from the docs.

  • The latest change combines page-specific keywords with the shared list and removes repeated terms.
  • Pages without their own terms use themeConfig.metadata.
  • CONTRIBUTING.md explains the new behavior.
  • No actionable new issues were found.
Diagram
%%{init: {'theme': 'neutral'}}%%
flowchart TD
  A[Read page front matter] --> B{keywords is an array?}
  B -->|Yes| C[Combine shared and page terms]
  C --> D[Remove repeated terms]
  D --> E[Return updated front matter]
  B -->|No| F[Return unchanged front matter]
  G[Shared keywords] --> H[Default site metadata]
Loading

Reviews (2) · Last reviewed commit: "Add page keywords to the site-wide list ..." · Reviewed by Greptile

greptile-apps[bot]
greptile-apps Bot previously approved these changes Oct 7, 2026
A markdown.parseFrontMatter hook prepends the site keywords to any doc's
own keywords, so pages with page-specific terms keep the site terms too.
@JoeKarow
JoeKarow merged commit d5bd196 into main Oct 7, 2026
6 checks passed
@JoeKarow
JoeKarow deleted the site-wide-seo-keywords branch October 7, 2026 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant