Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Convert API definitions section headings to sentence case

Summary

Converted all headings (H2-H6) in the API definitions section to sentence case while preserving proper nouns and technical terms. Also updated the Vale Headings.yml configuration with 29 new exceptions for API-related technical terms.

Changes made:

  • Vale configuration: Added exceptions for OpenAPI, AsyncAPI, Fern Definition, TLS, JWT, OAuth2, Protocol Buffers, Kubernetes, FastAPI, and other technical terms
  • Heading updates: Changed ~150+ headings across gRPC, OpenAPI, AsyncAPI, OpenRPC, and Fern Definition documentation from title case to sentence case
  • Scope: API definitions section only (fern/products/api-def/)

Examples:

  • "API Key Authentication" → "API key authentication"
  • "Bearer Token Authentication" → "Bearer token authentication"
  • "Protocol Buffer Best Practices" → "Protocol buffer best practices"
  • "Multiple Base URLs for a single API" → "Multiple base URLs for a single API"

Review & Testing Checklist for Human

  • Verify Vale exceptions are comprehensive: Check that all technical terms and proper nouns are correctly preserved (especially look at gRPC, OpenAPI, AsyncAPI headings)
  • Spot check sentence case application: Review a few files to ensure headings read naturally and no errors were introduced by the automated sed scripts
  • Run Vale locally: Verify that Vale passes on the changed files and that the new exceptions work as intended
  • Check for missed headings: Search for any remaining title case headings in the API definitions section that should have been converted

Notes

  • Used sed scripts for bulk changes, so there's a small risk of inconsistent application
  • Some trailing whitespace was added/removed in the process (cosmetic only)
  • Navigation titles in api-def.yml were already mostly in sentence case, so minimal changes there
  • Could not run Vale locally to verify, so CI checks will be important

Session: https://app.devin.ai/sessions/ba3a1ee1862744b0b5751f786a6ace2e
Requested by: Devin Logan (@devalog)

- Updated all headings in API definitions section to use sentence case
- Added new Vale exceptions for technical terms (OpenAPI, AsyncAPI, TLS, JWT, OAuth2, etc.)
- Fixed headings in gRPC, OpenAPI, AsyncAPI, OpenRPC, and Fern Definition pages
- Preserved proper nouns and Vale exceptions as specified

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

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

@devalog devalog merged commit b068bcd into main Oct 24, 2025
2 checks passed
@devalog devalog deleted the devin/1761328128-api-def-sentence-case branch October 24, 2025 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