Skip to content

Generate unique meta descriptions for changelog entries#1144

Merged
SahilAujla merged 5 commits intomainfrom
sa/changelog-unique-descriptions
Mar 20, 2026
Merged

Generate unique meta descriptions for changelog entries#1144
SahilAujla merged 5 commits intomainfrom
sa/changelog-unique-descriptions

Conversation

@SahilAujla
Copy link
Collaborator

Summary

  • Modify the changelog indexer to auto-generate a description for each entry from its H2 headings
  • Produces descriptions like "Week of January 8, 2026: updates to Developer Experience and Node."
  • Adds optional description field to ChangelogPathIndexEntry and includes it in Algolia records
  • Fixes duplicate meta descriptions across 10 changelog pages flagged by Semrush

Modify the changelog indexer to auto-generate a description for each
entry based on its H2 headings. Produces descriptions like "Week of
January 8, 2026: updates to Developer Experience and Node." which
differentiates changelog pages in search results.

Adds an optional description field to ChangelogPathIndexEntry and
includes it in both the path index and Algolia records.
@SahilAujla SahilAujla requested a review from a team as a code owner March 19, 2026 18:05
@github-actions
Copy link

github-actions bot commented Mar 19, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Mar 20, 2026, 6:11 PM

@github-actions
Copy link

github-actions bot commented Mar 19, 2026

🔍 Link Check

Status: ⏭️ Skipped (no content changes)

View workflow run

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ae6d1e638d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@SahilAujla
Copy link
Collaborator Author

@codex review

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5609d9aeae

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Address review feedback:
- Replace MONTH_NAMES array with native toLocaleDateString
- Remove unused date param from buildChangelogDescription
- Cap headings at 3 to stay well within the 155 char description limit
@SahilAujla SahilAujla merged commit 6d8324c into main Mar 20, 2026
8 checks passed
@SahilAujla SahilAujla deleted the sa/changelog-unique-descriptions branch March 20, 2026 18:20
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.

2 participants