Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Oct 22, 2025

Convert docs product headings and titles to sentence case

Summary

Converted headings and titles in the docs product section from title case to sentence case, following Vale style guidelines while preserving proper nouns and acronyms. This PR excludes changelog files and component-library content files per user request.

Changes:

  • 12 MDX files: Converted page headings in API references, integrations, customization, developer tools, and navigation sections
  • docs.yml: 2 navigation title updates ("Parameter Fields" → "Parameter fields", "Fern Editor" → "Fern editor")

Example changes:

  • "WebSocket Playground" → "WebSocket playground" (preserves "WebSocket" proper noun)
  • "Making Search Requests" → "Making search requests"
  • "Use Cases" → "Use cases"
  • "Fern Editor" → "Fern editor" (preserves "Fern", lowercases "editor" per Vale rules)

Excluded from scope:

  • All 16 changelog files
  • All 12 component-library .mdx content files

Review & Testing Checklist for Human

  • Verify scope: Confirm that the 2 component-library navigation titles in docs.yml ("Parameter fields", "Fern editor") should be included, or if ALL component-library references should be reverted
  • Visual inspection: Spot-check 3-5 changed pages on the preview URL to ensure headings render naturally and look correct in sentence case
  • Vale exceptions: Verify proper nouns are correctly preserved (WebSocket, API, GitHub should stay capitalized, while generic words like "playground", "interface", "steps" are lowercase)
  • Fern editor capitalization: Confirm "Fern editor" (not "Fern Editor") is correct - Vale has "Fern" in exceptions but not "editor"
  • Navigation functionality: Check that clicking through navigation and internal links still works correctly

Test Plan

  1. Review preview URL and navigate through the changed sections (API references, integrations, customization)
  2. Compare a few pages against production to ensure the sentence case looks natural
  3. Verify no broken links or unexpected rendering issues

Notes

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

devin-ai-integration bot and others added 2 commits October 22, 2025 17:26
- Fixed all changelog files (2024-2025)
- Fixed API reference files (api-explorer, generate-openrpc-ref, http-snippets, sdk-snippets, server-urls)
- Fixed component-library files (embed)
- Fixed customization files (search)
- Fixed integrations files (feature-flags)
- Fixed navigation files (overview)
- Preserved Vale exceptions (API Reference, API Explorer, Fern, GitHub, Markdown, etc.)

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
- Fixed feature-flags.mdx: Use cases, Component properties, etc.
- Fixed google.mdx: Integration steps

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@github-actions
Copy link
Contributor

devin-ai-integration bot and others added 2 commits October 22, 2025 17:30
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
- Fixed cursor.mdx: Callouts, Cards & card groups

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@github-actions
Copy link
Contributor

@devalog
Copy link
Collaborator

devalog commented Oct 23, 2025

For now, can you remove all changes to changelog files and to component files? (The component files should be handled in a separate PR because there's a lot of nuance with capitalization)

Per user request, removing changes to:
- All changelog files (2024-2025)
- Component library embed.mdx file

These will be handled in separate PRs

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@github-actions
Copy link
Contributor

Per user request, reverting:
- All 12 component-library MDX files (accordion-groups, card-groups, code-blocks, embed, endpoint snippets, icons, overview, runnable-endpoint, steps, visual-editor)
- All component-library navigation titles in docs.yml

Component-library changes will be handled in a separate PR

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@devalog devalog merged commit 6a348a5 into main Oct 23, 2025
2 checks passed
@devalog devalog deleted the devin/1761152906-docs-product-sentence-case branch October 23, 2025 18:41
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