Skip to content

Commit 6a348a5

Browse files
Convert docs product headings and titles to sentence case (#1383)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <[email protected]>
1 parent e8e3663 commit 6a348a5

File tree

13 files changed

+97
-76
lines changed

13 files changed

+97
-76
lines changed

.vale/styles/FernStyles/Acronyms.yml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ exceptions:
1111
- API
1212
- ASP
1313
- CLI
14-
- CNAME # Fern-specific
14+
- CNAME
1515
- CPU
1616
- CSS
1717
- CSV
1818
- DEBUG
19-
- DNS # Fern-specific
19+
- DNS
2020
- DOM
2121
- DPI
2222
- FAQ
@@ -56,7 +56,7 @@ exceptions:
5656
- TBD
5757
- TCP
5858
- TODO
59-
- TXT # Fern-specific
59+
- TXT
6060
- URI
6161
- URL
6262
- USB
@@ -65,7 +65,9 @@ exceptions:
6565
- XSS
6666
- YAML
6767
- ZIP
68-
- MDX # Fern-specific
69-
- SEO # Fern-specific
70-
- AWS # Fern-specific
71-
- LLM # Fern-specific
68+
- MDX
69+
- SEO
70+
- AWS
71+
- OpenRPC
72+
- gRPC
73+
- RPC

.vale/styles/FernStyles/Headings.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,11 @@ exceptions:
3232
- GitHub
3333
- README
3434
- Action
35-
- Actions
35+
- Actions
36+
- WebSocket
37+
- WebSocket Playground
38+
- OpenRPC
39+
- gRPC
40+
- RPC
41+
- SDK
42+
- SDKs

fern/products/docs/pages/api-references/api-explorer.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subtitle: Reduce "time to 200" by allowing users to make real calls to your API
55

66
Fern's API Explorer allows users to make authenticated requests to your API without ever leaving your documentation.
77

8-
### Auto-populate with examples
8+
### Autopopulate with examples
99
Fern will automatically populate the fields of the endpoint with the values set in your API specification.
1010

1111
<div style="position: relative; padding-bottom: 50.63657407407407%; height: 0;"><iframe src="https://www.loom.com/embed/a48d921459b54dde9652c3fcc85ebc54?sid=2c0b4f4d-7e24-4fc5-a617-8d933195bfec?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
@@ -28,4 +28,4 @@ Allow users to test their calls in a sandbox environment or select the environme
2828

2929
For APIs that support WebSocket connections, the API Explorer includes a **WebSocket**-specific Playground. The WebSocket Playground also allows users to establish a connection with the API, and send/receive messages in real-time.
3030

31-
<div style="position: relative; padding-bottom: 56.2%; height: 0;"><iframe src="https://www.loom.com/embed/be4da30404794e9983c4fe639f78d4c8?sid=73b7aeda-98fa-4531-87ed-1e5909500fe2?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
31+
<div style="position: relative; padding-bottom: 56.2%; height: 0;"><iframe src="https://www.loom.com/embed/be4da30404794e9983c4fe639f78d4c8?sid=73b7aeda-98fa-4531-87ed-1e5909500fe2?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

fern/products/docs/pages/api-references/autopopulate-api-key.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ The JWT should have a structure similar to:
9191

9292
#### Setting up auto-populated API keys
9393

94-
- [ ] Reach out to Fern to get your secret key
94+
- [ ] Reach out to Fern to get your secret key
9595
- [ ] Send Fern the URL of your authentication page. This is where users will be redirected to after clicking the "Login" button in the API Explorer.
9696
- [ ] Add logic to your service to set the `fern_token` cookie when a user logs in
9797

fern/products/docs/pages/api-references/generate-openrpc-ref.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Fern enables you to generate professional, interactive API reference documentati
99
<img src="./alchemy-openrpc.png" alt="Alchemy's OpenRPC API Reference Example" />
1010
</Frame>
1111

12-
## How to Add an OpenRPC Endpoint
12+
## How to add an OpenRPC endpoint
1313

1414
1. Add your OpenRPC specification file (e.g., `openrpc.yaml`) to your `/fern` directory.
1515
2. Configure your `generators.yml` to point to your OpenRPC spec:
@@ -22,18 +22,18 @@ Fern enables you to generate professional, interactive API reference documentati
2222
```
2323
</CodeBlock>
2424
25-
### Configuration Properties
25+
### Configuration properties
2626
2727
<ParamField path="api.specs[].openrpc" required>
2828
Path to your OpenRPC specification file. You can include multiple OpenRPC specs if your project exposes more than one JSON-RPC API.
2929
</ParamField>
3030
31-
## Common Use Cases
31+
## Common use cases
3232
3333
JSON-RPC APIs are widely used for:
3434
- **Blockchain & Crypto**: Node RPC endpoints, wallet APIs
3535
- **FinTech**: Trading platforms, market data feeds
3636
- **Developer Tools**: Language servers, debuggers, automation
3737
- **Distributed Systems**: Remote procedure calls between services
3838
39-
Leverage Fern and OpenRPC to deliver world-class developer experiences for your JSON-RPC APIs.
39+
Leverage Fern and OpenRPC to deliver world-class developer experiences for your JSON-RPC APIs.

fern/products/docs/pages/api-references/http-snippets.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ settings:
3131
```
3232
</CodeBlock>
3333
34-
## How It Works
34+
## How it works
3535
36-
### Request Examples
36+
### Request examples
3737
3838
To generate HTTP snippets, add request examples to your API definition:
3939
- For Fern Definition: Follow the [examples documentation](/learn/api-definition/fern/examples)
4040
- For OpenAPI: Follow the [request/response examples documentation](/learn/api-definition/openapi/extensions/others#request--response-examples)
4141
42-
### Set Default Snippet Language
42+
### Set default snippet language
4343
4444
HTTP snippets support several languages. Our development work is driven by customer requests, so please request support for languages not listed here by [opening an issue](https://github.com/fern-api/fern/issues/new/choose).
4545
@@ -66,7 +66,7 @@ navigation:
6666
```
6767
</CodeBlock>
6868

69-
### Generated Features
69+
### Generated features
7070

7171
HTTP snippets automatically include:
7272
- Authentication headers with placeholders (e.g., `<apiKey>`)
@@ -75,7 +75,7 @@ HTTP snippets automatically include:
7575
- Error handling patterns
7676
- SSL/TLS configuration where applicable
7777

78-
### Display Behavior
78+
### Display behavior
7979

8080
- If your API has SDK snippets, those will be shown by default
8181
- If no SDK snippets exist, HTTP snippets will display automatically

fern/products/docs/pages/api-references/sdk-snippets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ description: Enable SDK code examples in TypeScript, Python, Go, and more from t
1515
![SDK code snippet selector](https://fern-image-hosting.s3.amazonaws.com/sdk-code-snippets.png)
1616
</Frame>
1717

18-
## Configuring SDK Snippets
18+
## Configuring SDK snippets
1919

2020
To configure SDK snippets, you'll need to name your SDKs in `generators.yml` and then reference that name in `docs.yml`.
2121

fern/products/docs/pages/api-references/server-urls.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You can configure multiple server URLs in your API definition using either Fern
1313
- [Configure servers in OpenAPI](/learn/api-definition/openapi/extensions/others#server-names)
1414
- [Configure environments in Fern Definition](/learn/api-definition/fern/api-yml/environments)
1515

16-
## User Interface
16+
## User interface
1717

1818
When multiple servers are configured, users will see a dropdown menu in the API Reference that allows them to switch between environments:
1919

@@ -45,7 +45,7 @@ Here's an example of the [Flagright docs site](https://docs.flagright.com/framl-
4545
</Tab>
4646
</Tabs>
4747
48-
## Environment Persistence
48+
## Environment persistence
4949
5050
When you select an environment, it's reflected across the entire API Reference - both in the displayed URLs and in the [API Explorer](/learn/docs/api-references/api-explorer). This selection persists as you navigate between different pages.
5151

fern/products/docs/pages/customization/search.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If you are using the AI Search feature, the search box also functions as your si
3030

3131
If you need to integrate Fern's documentation search into your own application or dashboard, you can request Algolia credentials directly from the Fern team. These credentials will allow you to query the same search index that powers your documentation site's search functionality.
3232

33-
### Making Search Requests
33+
### Making search requests
3434

3535
Once you have your credentials, you can make requests to Algolia's API to search your documentation.
3636

@@ -42,4 +42,4 @@ Contact the Fern team to get your specific application ID and index name. Creden
4242

4343
## Using an alternative search
4444

45-
You can override Fern's search with your own solution using [custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript) and your Algolia credentials.
45+
You can override Fern's search with your own solution using [custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript) and your Algolia credentials.

fern/products/docs/pages/getting-started/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
9393
<img class="mx-auto hidden dark:block" alt="API Specs" src="./images/api-specs-dark.png" />
9494
<div class="w-full space-y-1 overflow-hidden">
9595
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
96-
Bring your own API Spec
96+
Bring your own API spec
9797
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
9898
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
9999
</div>
@@ -144,7 +144,7 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
144144
<img class="mx-auto hidden dark:block" alt="Fern's MCP Server" src="./images/mcp-server-dark.png" />
145145
<div class="w-full space-y-1 overflow-hidden">
146146
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
147-
Fern's MCP Server
147+
Fern's MCP server
148148
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
149149
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
150150
</div>

0 commit comments

Comments
 (0)