Skip to content

fix(docs): fix spelling, grammar, and formatting across docs#2882

Open
kimsauce wants to merge 1 commit into
algolia:mainfrom
kimsauce:fix/docs-editorial
Open

fix(docs): fix spelling, grammar, and formatting across docs#2882
kimsauce wants to merge 1 commit into
algolia:mainfrom
kimsauce:fix/docs-editorial

Conversation

@kimsauce
Copy link
Copy Markdown

@kimsauce kimsauce commented May 7, 2026

Summary

  • Fix typos, grammar mistakes, and punctuation across 18 documentation files
  • Capitalize proper nouns consistently: JavaScript, DocSearch, Ask AI, LLM, Starlight
  • Fix broken code samples: missing trailing comma in record-extractor.md, missing semicolon in sidepanel/advanced-use-cases.mdx
  • Add missing Solution paragraph to the AI-211 - Stream error entry in askai-errors.mdx
  • Remove trailing colons from section headings (api.mdx, sidepanel/api-reference.mdx)
  • Fix internal link in askai-markdown-indexing.mdx (removed .mdx extension)

Files changed

api.mdx, composable-api.mdx, crawler.mdx, docsearch-program.md, examples.mdx, integrations.md, manage-your-crawls.mdx, migrating-from-legacy.mdx, migrating-from-v3.md, record-extractor.md, required-configuration.mdx, sidepanel/advanced-use-cases.mdx, sidepanel/api-reference.mdx, sidepanel/getting-started.mdx, templates.mdx, v4/askai-errors.mdx, v4/askai.mdx, what-is-docsearch.md

Test plan

  • Verify Docusaurus site builds without errors (yarn start from packages/website)
  • Spot-check affected pages in the browser for rendering correctness

🤖 Generated with Claude Code

- Fix typos and grammar across 18 docs files (curly apostrophe in code
  sample, verb agreement, possessives, missing punctuation, etc.)
- Capitalize proper nouns: JavaScript, DocSearch, Ask AI, LLM, Starlight
- Fix code sample syntax: missing trailing comma in record-extractor,
  missing semicolon in sidepanel advanced-use-cases
- Add missing Solution paragraph to AI-211 error entry in askai-errors
- Remove trailing colons from section headings (api.mdx, api-reference.mdx)
- Fix internal link in askai-markdown-indexing (.mdx extension removed)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 7, 2026

👷 Deploy request for docsearch pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 2a36319

@netlify
Copy link
Copy Markdown

netlify Bot commented May 7, 2026

Deploy Preview for docsearch-demo ready!

Name Link
🔨 Latest commit 2a36319
🔍 Latest deploy log https://app.netlify.com/projects/docsearch-demo/deploys/69fbe10a52af8600095c21a0
😎 Deploy Preview https://deploy-preview-2882--docsearch-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes.

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