Skip to content

Fix sentence case in titles and headings #1443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2025
Merged

Fix sentence case in titles and headings #1443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions fern/products/api-def/asyncapi-pages/automation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sync your AsyncAPI Specification
title: Sync your AsyncAPI specification
subtitle: Automatically sync your AsyncAPI spec changes to keep SDKs and docs up to date
---

Expand Down Expand Up @@ -200,4 +200,4 @@ api:
version: 0.8.8
```

This ensures that any breaking changes to your AsyncAPI specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.
This ensures that any breaking changes to your AsyncAPI specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.
4 changes: 2 additions & 2 deletions fern/products/api-def/asyncapi-pages/extensions/parameter-names.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Parameter Names
title: Parameter names
subtitle: Use `x-fern-parameter-name` to customize SDK parameter names for message properties
---

Expand Down Expand Up @@ -76,4 +76,4 @@ channels:
type: string
```
This ensures consistent naming conventions across your SDK while maintaining compatibility with your existing message formats.
This ensures consistent naming conventions across your SDK while maintaining compatibility with your existing message formats.
4 changes: 2 additions & 2 deletions fern/products/api-def/asyncapi-pages/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: What is an AsyncAPI Specification?
title: What is an AsyncAPI specification?

Check failure on line 2 in fern/products/api-def/asyncapi-pages/overview.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'what's' instead of 'What is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'what's' instead of 'What is'.", "location": {"path": "fern/products/api-def/asyncapi-pages/overview.mdx", "range": {"start": {"line": 2, "column": 8}}}, "severity": "ERROR"}
description: AsyncAPI is a standard for documenting event-driven APIs
---

Expand Down Expand Up @@ -174,4 +174,4 @@
└─ asyncapi.yml
```
</Step>
</Steps>
</Steps>
4 changes: 2 additions & 2 deletions fern/products/api-def/ferndef-pages/api-yml/global-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Global Configuration
title: Global configuration
description: Specify global headers, path parameters or query parameters meant to be included on every request.
---

Expand Down Expand Up @@ -52,4 +52,4 @@
## Global query parameters

You cannot yet specify query parameters that are meant to be included on every request.
If you'd like to see this feature, please upvote [this issue](https://github.com/fern-api/fern/issues/2930).
If you'd like to see this feature, please upvote [this issue](https://github.com/fern-api/fern/issues/2930).

Check warning on line 55 in fern/products/api-def/ferndef-pages/api-yml/global-configuration.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[FernStyles.Please] Avoid using 'please' in technical documentation.

Raw Output:
{"message": "[FernStyles.Please] Avoid using 'please' in technical documentation.", "location": {"path": "fern/products/api-def/ferndef-pages/api-yml/global-configuration.mdx", "range": {"start": {"line": 55, "column": 36}}}, "severity": "WARNING"}
2 changes: 1 addition & 1 deletion fern/products/api-def/ferndef-pages/endpoints/bytes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Binary Data and Files
title: Binary data and files
subtitle: Use the `bytes` type to handle binary data in your API
---

Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/ferndef-pages/endpoints/multipart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Multipart File Upload
title: Multipart file upload
description: Document endpoints with the `multiform` content type.
---

Expand Down
4 changes: 2 additions & 2 deletions fern/products/api-def/ferndef-pages/endpoints/sse.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Server-Sent Events and Streaming APIs
title: Server-sent events and streaming APIs
subtitle: Use the `response-stream` key to model streaming endpoints
---

Expand Down Expand Up @@ -97,4 +97,4 @@ types:
ChatChunk:
properties:
text: string
```
```
4 changes: 2 additions & 2 deletions fern/products/api-def/grpc-pages/automation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sync your gRPC Specification
title: Sync your gRPC specification
subtitle: Automatically sync your Protocol Buffer changes to keep SDKs and docs up to date
---

Expand Down Expand Up @@ -469,4 +469,4 @@ if __name__ == "__main__":
sync_from_grpc_reflection("localhost:50051", "proto/")
```

This ensures that any changes to your gRPC services are automatically reflected in your SDKs and documentation, maintaining consistency across your entire API ecosystem.
This ensures that any changes to your gRPC services are automatically reflected in your SDKs and documentation, maintaining consistency across your entire API ecosystem.
4 changes: 2 additions & 2 deletions fern/products/api-def/grpc-pages/services/errors.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Error Handling
title: Error handling
subtitle: Implement robust error handling with gRPC status codes and custom error details
---

Expand Down Expand Up @@ -523,4 +523,4 @@ message CreateUserResult {
}
```

Proper error handling in gRPC ensures robust, maintainable services that provide clear feedback to clients about what went wrong and how to fix it.
Proper error handling in gRPC ensures robust, maintainable services that provide clear feedback to clients about what went wrong and how to fix it.
4 changes: 2 additions & 2 deletions fern/products/api-def/openapi-pages/automation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sync your OpenAPI Specification
title: Sync your OpenAPI specification
subtitle: Pull your latest OpenAPI Specification into your Fern Folder automatically.
---

Expand Down Expand Up @@ -59,4 +59,4 @@ This creates daily pull requests with any API spec updates. To change the freque

## Other use cases

If your OpenAPI spec lives in a different repository (rather than at a public URL), you can sync it to your Fern folder using explicit file mappings. See the [sync-openapi GitHub Action README](https://github.com/fern-api/sync-openapi) for this and other advanced configurations.
If your OpenAPI spec lives in a different repository (rather than at a public URL), you can sync it to your Fern folder using explicit file mappings. See the [sync-openapi GitHub Action README](https://github.com/fern-api/sync-openapi) for this and other advanced configurations.
2 changes: 1 addition & 1 deletion fern/products/api-def/openapi-pages/endpoints/multipart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Multipart File Upload
title: Multipart file upload
subtitle: Document endpoints with the `multipart/form-data` content type
---

Expand Down
4 changes: 2 additions & 2 deletions fern/products/api-def/openapi-pages/endpoints/sse.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Server-Sent Events and Streaming APIs
title: Server-sent events and streaming APIs
subtitle: Use the `x-fern-streaming` extension to model streaming endpoints
---

Expand Down Expand Up @@ -105,4 +105,4 @@ components:
properties:
text:
type: string
```
```
4 changes: 2 additions & 2 deletions fern/products/api-def/openapi-pages/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: What is an OpenAPI Specification?
title: What is an OpenAPI specification?

Check failure on line 2 in fern/products/api-def/openapi-pages/overview.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'what's' instead of 'What is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'what's' instead of 'What is'.", "location": {"path": "fern/products/api-def/openapi-pages/overview.mdx", "range": {"start": {"line": 2, "column": 8}}}, "severity": "ERROR"}
description: OpenAPI is a standard for documenting REST APIs
---

Expand Down Expand Up @@ -162,5 +162,5 @@
├─ generators.yml
└─ openapi/
├─ openapi.yml
```
```

4 changes: 2 additions & 2 deletions fern/products/api-def/openrpc-pages/automation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sync your OpenRPC Specification
title: Sync your OpenRPC specification
subtitle: Automatically sync your OpenRPC spec changes to keep SDKs and docs up to date
---

Expand Down Expand Up @@ -313,4 +313,4 @@ if __name__ == "__main__":
save_spec_as_yaml(spec, "fern/openrpc/openrpc.yml")
```

This ensures that any breaking changes to your OpenRPC specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.
This ensures that any breaking changes to your OpenRPC specification are detected and the appropriate team members are notified before the changes are propagated to your SDKs and documentation.
4 changes: 2 additions & 2 deletions fern/products/api-def/openrpc-pages/extensions/parameter-names.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Parameter Names
title: Parameter names
subtitle: Use `x-fern-parameter-name` to customize SDK parameter names for JSON-RPC method parameters
---

Expand Down Expand Up @@ -277,4 +277,4 @@ await client.math.calculate({
});
```

Using custom parameter names ensures consistent naming conventions across your SDK while maintaining compatibility with your existing JSON-RPC method signatures.
Using custom parameter names ensures consistent naming conventions across your SDK while maintaining compatibility with your existing JSON-RPC method signatures.
2 changes: 1 addition & 1 deletion fern/products/api-def/openrpc-pages/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: What is an OpenRPC Specification?
title: What is an OpenRPC specification?

Check failure on line 2 in fern/products/api-def/openrpc-pages/overview.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'what's' instead of 'What is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'what's' instead of 'What is'.", "location": {"path": "fern/products/api-def/openrpc-pages/overview.mdx", "range": {"start": {"line": 2, "column": 8}}}, "severity": "ERROR"}
description: OpenRPC is a standard for documenting JSON-RPC APIs
---

Expand Down