Skip to content

Commit cb09944

Browse files
Convert all headings and page titles to sentence case
- Convert all markdown headings (# Heading, ## Subheading, etc.) to sentence case - Update page titles in YAML navigation files to sentence case - Preserve proper nouns and product names (Fern Editor, Markdown, OpenAPI, etc.) - Preserve technical terms (API, SDK, CLI, HTTP, JSON, YAML, etc.) - Preserve acronyms (AI, PR, RBAC, SSO, OAuth, etc.) Excludes changelog files and api directory files. Modified 103 files across MDX content and YAML navigation files. Co-Authored-By: Devin Logan <[email protected]>
1 parent b87f5f7 commit cb09944

File tree

103 files changed

+996
-996
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+996
-996
lines changed

fern/docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ instances:
88
repo: docs
99
branch: main
1010

11-
title: Fern Documentation
11+
title: Fern documentation
1212

1313
metadata:
1414
og:image: https://fern-docs.s3.us-east-2.amazonaws.com/fern-docs-og_image-compressed.png
@@ -43,14 +43,14 @@ products:
4343
slug: ask-fern
4444
subtitle: Let users find answers in your documentation instantly
4545

46-
- display-name: CLI Reference
46+
- display-name: CLI reference
4747
subtitle: Manage and configure your Fern projects
4848
path: ./products/cli-api-reference/cli-api-reference.yml
4949
icon: fa-regular fa-terminal
5050
image: ./images/product-switcher/product-switcher-cliapi-light.png
5151
slug: cli-api-reference
5252

53-
- display-name: API Definitions
53+
- display-name: API definitions
5454
path: ./products/api-def/api-def.yml
5555
icon: fa-regular fa-book
5656
image: ./images/product-switcher/openapi-definition-light.png

fern/products/api-def/api-def.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ navigation:
3131
- page: Multipart form uploads
3232
path: ./openapi-pages/endpoints/multipart.mdx
3333
slug: multipart
34-
- page: Server-sent events
34+
- page: Server-Sent Events
3535
path: ./openapi-pages/endpoints/sse.mdx
3636
slug: sse
3737
- section: Extensions
@@ -145,7 +145,7 @@ navigation:
145145
- section: Methods
146146
slug: methods
147147
contents:
148-
- page: JSON-RPC methods
148+
- page: Json-rpc methods
149149
path: ./openrpc-pages/methods/rpc-methods.mdx
150150
slug: rpc-methods
151151
- page: Notifications
@@ -238,7 +238,7 @@ navigation:
238238
- page: Bytes
239239
path: ./ferndef-pages/endpoints/bytes.mdx
240240
slug: bytes
241-
- page: Server-sent events
241+
- page: Server-Sent Events
242242
path: ./ferndef-pages/endpoints/sse.mdx
243243
slug: sse
244244
- section: Advanced
@@ -259,7 +259,7 @@ navigation:
259259
path: ./ferndef-pages/audiences.mdx
260260
- page: Availability
261261
path: ./ferndef-pages/availability.mdx
262-
- section: api.yml reference
262+
- section: Api.yml reference
263263
slug: api-yml
264264
contents:
265265
- page: Overview
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
navigation:
2-
- page: AsyncAPI Definition Redirect Page
2+
- page: AsyncAPI definition redirect page
33
path: ./pages/asyncapi-empty.mdx
44
slug: empty-page
55
hidden: true

fern/products/api-def/asyncapi-pages/auth.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ components:
5959
env: AUTH_TOKEN
6060
```
6161

62-
## API Key security scheme
62+
## API key security scheme
6363

6464
Start by defining an `apiKey` security scheme in your `asyncapi.yml`:
6565

@@ -81,7 +81,7 @@ const client = new Client({
8181
})
8282
```
8383

84-
### Custom API Key variable name
84+
### Custom API key variable name
8585

8686
If you want to control variable naming and the environment variable to scan,
8787
use the configuration below:
@@ -120,7 +120,7 @@ const client = new Client({
120120
})
121121
```
122122

123-
### Custom Basic Auth variable names
123+
### Custom basic auth variable names
124124

125125
If you want to control variable naming and the environment variables to scan,
126126
use the configuration below:
@@ -139,7 +139,7 @@ components:
139139
env: PASSWORD
140140
```
141141

142-
## OAuth2 security scheme
142+
## Oauth2 security scheme
143143

144144
<Markdown src="/snippets/pro-plan.mdx"/>
145145

fern/products/api-def/asyncapi-pages/automation.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subtitle: Automatically sync your AsyncAPI spec changes to keep SDKs and docs up
55

66
Keeping your AsyncAPI specifications in sync with your codebase is crucial for maintaining accurate SDKs and documentation. Fern provides several automation options to streamline this process.
77

8-
## GitHub Actions
8+
## GitHub actions
99

1010
Use Fern's GitHub Action to automatically update SDKs and docs when your AsyncAPI spec changes:
1111

@@ -85,7 +85,7 @@ api:
8585
version: 0.8.8
8686
```
8787
88-
### From Git repository
88+
### From git repository
8989
```yaml title="generators.yml" {3-7}
9090
api:
9191
specs:
@@ -99,9 +99,9 @@ api:
9999
version: 0.8.8
100100
```
101101
102-
## CI/CD integration
102+
## Ci/cd integration
103103
104-
### CircleCI
104+
### Circleci
105105
```yaml title=".circleci/config.yml" {15-23}
106106
version: 2.1
107107

@@ -126,7 +126,7 @@ workflows:
126126
- fern-context
127127
```
128128
129-
### GitLab CI
129+
### GitLab ci
130130
```yaml title=".gitlab-ci.yml" {13-20}
131131
stages:
132132
- build

fern/products/api-def/asyncapi-pages/channels/bindings.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ operations:
5858
method: message
5959
```
6060
61-
## MQTT bindings
61+
## Mqtt bindings
6262
6363
Configure MQTT-specific settings for IoT and messaging applications:
6464

fern/products/api-def/asyncapi-pages/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ components:
109109
- message
110110
```
111111
112-
## Set up your fern folder
112+
## Set up your Fern folder
113113
114114
<Info>
115115
Considering options to generate an AsyncAPI spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
navigation:
2-
- page: Fern Definition Redirect Page
2+
- page: Fern Definition redirect page
33
path: ./pages/ferndef-empty.mdx
44
slug: empty-page
55
hidden: true

fern/products/api-def/ferndef-pages/audiences.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ groups:
9999
...
100100
```
101101

102-
## Audiences with docs
102+
## Audiences with docs
103103

104104
If generating Fern Docs, update your `docs.yml` configuration to include your audiences.
105105

fern/products/api-def/ferndef-pages/availability.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Availability can be:
1313
- `deprecated` which means it will be removed in the future; will show a `Deprecated` tag
1414
- `generally-available` which means it is stable and available for use; will show a `GA` tag
1515

16-
### Endpoint
16+
### Endpoint
1717

1818
<CodeBlock title="pet.yml">
1919
```yaml {6}
@@ -71,7 +71,7 @@ In Fern Docs, this will look like:
7171
![Screenshot showing a beta tag next to a type in API Reference docs](https://fern-image-hosting.s3.amazonaws.com/type-beta.png)
7272
</Frame>
7373
74-
### Property
74+
### Property
7575
7676
<CodeBlock title="pet.yml">
7777
```yaml {12}

0 commit comments

Comments
 (0)