Skip to content

Fix generated documentation descriptions - #1259

Merged
tannerlinsley merged 1 commit into
mainfrom
taren/seo-doc-descriptions
Sep 11, 2026
Merged

tannerlinsley merged 1 commit into
mainfrom
taren/seo-doc-descriptions

Conversation

@tannerlinsley

Copy link
Copy Markdown
Member

Documentation descriptions currently lose linked words, include image captions and callout markers, and can cut words in half. Extract plain prose from the existing Markdown parser and use it directly for metadata. Keep image-bearing excerpts for cards and preserve explicit frontmatter descriptions.

Validation: full pre-commit pnpm test passed, including both TypeScript projects, lint, and 515 passing unit tests with two environment skips. Five regression tests cover links, callouts, images, reference links, inline code, entities, explicit descriptions, and truncation. A 55-document source check produced no empty descriptions or raw callout markers. Browser inspection confirmed matching clean description and Open Graph description tags on the local SEO guide.

@tannerlinsley
tannerlinsley requested a review from a team September 11, 2026 20:36
@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 18 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: c6183677-c9f6-4eca-9eb4-65846219451b

📥 Commits

Reviewing files that changed from the base of the PR and between dacf031 and 82f3169.

📒 Files selected for processing (3)
  • src/utils/docs.functions.ts
  • src/utils/documents.server.ts
  • tests/document-descriptions.test.ts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 11, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
tanstack-com 82f3169 Commit Preview URL

Branch Preview URL
Sep 11 2026, 08:38 PM

@tannerlinsley
tannerlinsley merged commit 3080fe5 into main Sep 11, 2026
7 checks passed
@tannerlinsley
tannerlinsley deleted the taren/seo-doc-descriptions branch September 11, 2026 20:40
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