Skip to content

Commit 8f35197

Browse files
Convert component-library headings and titles to sentence case (#1405)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <[email protected]>
1 parent 5529d16 commit 8f35197

File tree

10 files changed

+75
-32
lines changed

10 files changed

+75
-32
lines changed

.vale.ini

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Microsoft.Accessibility = NO
1919
Microsoft.Passive = NO
2020
Microsoft.Suspended = NO
2121
Microsoft.Vocab = NO
22+
Microsoft.Semicolon = NO # Mostly just picks up code
23+
Microsoft.SentenceLength = NO # Mostly just picks up code
24+
Microsoft.Dashes = NO
2225

2326
# Not relevant for Fern audience
2427
Microsoft.GeneralURL = NO

.vale/styles/FernStyles/Headings.yml

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,44 @@ exceptions:
3939
- gRPC
4040
- RPC
4141
- SDK
42-
- SDKs
42+
- SDKs
43+
- Accordion
44+
- Accordions
45+
- Accordion Groups
46+
- Aside
47+
- Badge
48+
- Badges
49+
- Button
50+
- Callout
51+
- Callouts
52+
- Card
53+
- Cards
54+
- Card Groups
55+
- Code Blocks
56+
- CodeBlock
57+
- CodeBlocks
58+
- CodeGroup
59+
- Embed
60+
- Endpoint Request Snippet
61+
- Endpoint Response Snippet
62+
- Endpoint Schema Snippet
63+
- Frame
64+
- Frames
65+
- Icon
66+
- Icons
67+
- Param Field
68+
- Param Fields
69+
- ParamField
70+
- Runnable Endpoint
71+
- Step
72+
- Steps
73+
- Sticky Table
74+
- StickyTable
75+
- Tab
76+
- Tabs
77+
- Tooltip
78+
- Tooltips
79+
- PDF
80+
- CSS
81+
- HTML
82+
- JSON

fern/products/docs/pages/component-library/custom-components/conditional-rendering.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Conditionally Rendered Content
2+
title: Conditionally rendered content
33
---
44

55
You can conditionally render content based on the instance or version of the docs, in addition to the role of an authenticated user.
@@ -46,4 +46,4 @@ instances:
4646
<If viewer={["admin"]}>
4747
This is an admin feature. It should only be available when the user is an admin.
4848
</If>
49-
```
49+
```

fern/products/docs/pages/component-library/custom-components/custom-css-js.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ You can use custom CSS to create brand-specific styling for tables, components,
139139

140140
## Custom JavaScript
141141

142-
Customize the behavior of your Docs site by injecting custom JavaScript globally. Add a `custom.js` file and include it in your `fern/` project:
142+
Customize the behavior of your Docs site by injecting custom JavaScript globally.Add a `custom.js` file and include it in your `fern/` project:
143143

144144
<CodeBlock title="Add the custom.js file">
145145
```bash {5}
@@ -266,8 +266,8 @@ ReactDOM.render(
266266
- `ReactDOM.render()` may need to be called multiple times to prevent it from unmounting (this side-effect will be removed in the future).
267267
- `yarn build` or `npm build` must generate files with deterministic names to be referenced in `docs.yml`. The above example uses a [`vite` config](https://github.com/fern-api/docs-custom-js-example/blob/main/custom-app/vite.config.ts) to accomplish this.
268268
- For your hosted Docs site, you may need to update your CD steps to include building the react-app.
269-
- Custom components are not supported in local development. They are supported in preview links.
269+
- Custom components aren't supported in local development, but are supported in preview links.
270270

271271
<Info>
272272
This approach is subject to change, with notice, as we make improvements to the plugin architecture.
273-
</Info>
273+
</Info>

fern/products/docs/pages/component-library/default-components/accordion-groups.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: 'Display expandable/collapsible options that reveal more informatio
66
Accordion Groups allow you to organize content into collapsible sections, making it easier for users to navigate through information. With recent updates, our Accordion component now supports improved search functionality using the browser's built-in search feature.
77

88
<AccordionGroup>
9-
<Accordion title="Basic Usage">
9+
<Accordion title="Basic usage">
1010
Accordion Groups can contain multiple Accordion items. Each item has a title and content that can be expanded or collapsed.
1111

1212
```jsx
@@ -21,7 +21,7 @@ Accordion Groups allow you to organize content into collapsible sections, making
2121
```
2222
</Accordion>
2323

24-
<Accordion title="Searchable Content">
24+
<Accordion title="Searchable content">
2525
The updated Accordion component now uses HTML5 `<details>` and `<summary>` elements, enabling browser search (Cmd+F / Ctrl+F) to find content within collapsed sections.
2626
</Accordion>
2727

@@ -30,22 +30,22 @@ Accordion Groups allow you to organize content into collapsible sections, making
3030
</Accordion>
3131
</AccordionGroup>
3232

33-
### Enhanced Search Functionality
33+
### Enhanced search functionality
3434

3535
The recent update to our Accordion component improves content discoverability by allowing users to search through all content, including collapsed sections, using the browser's search function (Cmd+F / Ctrl+F).
3636

37-
### Usage Examples
37+
### Usage examples
3838

3939
Here are some examples of how to use the Accordion Group component:
4040

4141
<Tabs>
4242
<Tab title="Example">
4343
<AccordionGroup>
44-
<Accordion title="Simple Text Content">
44+
<Accordion title="Simple text content">
4545
This is a basic example with text content.
4646
</Accordion>
4747

48-
<Accordion title="With Code Snippets">
48+
<Accordion title="With code snippets">
4949
You can include code snippets within Accordions:
5050

5151
```javascript
@@ -55,7 +55,7 @@ Here are some examples of how to use the Accordion Group component:
5555
```
5656
</Accordion>
5757

58-
<Accordion title="Nested Components">
58+
<Accordion title="Nested components">
5959
Accordions can contain other components:
6060

6161
<Frame caption="Sample image">
@@ -65,14 +65,14 @@ Here are some examples of how to use the Accordion Group component:
6565
</AccordionGroup>
6666
</Tab>
6767
<Tab title="Markdown">
68-
<CodeBlock title="Example Usage">
68+
<CodeBlock title="Example usage">
6969
````jsx
7070
<AccordionGroup>
71-
<Accordion title="Text Example">
71+
<Accordion title="Text example">
7272
This is a basic example of an accordion group.
7373
</Accordion>
7474

75-
<Accordion title="Multimedia Example">
75+
<Accordion title="Multimedia example">
7676
You can embed photos, videos, and other media within accordions for rich interactive content.
7777

7878
<embed
@@ -83,7 +83,7 @@ Here are some examples of how to use the Accordion Group component:
8383
/>
8484
</Accordion>
8585

86-
<Accordion title="Rich Content Support">
86+
<Accordion title="Rich content support">
8787
Accordions can contain rich content including code blocks, callouts, and other components.
8888

8989
```ts
@@ -93,7 +93,7 @@ Here are some examples of how to use the Accordion Group component:
9393
```
9494
</Accordion>
9595

96-
<Accordion title="Best Practices Using Accordion Groups">
96+
<Accordion title="Best practices using Accordion Groups">
9797
- Use accordion groups when you have multiple related sections
9898
- Each accordion should have a clear title
9999
- Keep content concise and focused

fern/products/docs/pages/component-library/default-components/code-blocks.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -272,13 +272,13 @@ By default, long lines that exceed the width of the code block become scrollable
272272

273273
<Tabs>
274274
<Tab title="Example">
275-
```txt title="Without Word Wrap"
275+
```txt title="Without wordWrap"
276276
A very very very long line of text that may cause the code block to overflow and scroll as a result.
277277
```
278278
</Tab>
279279
<Tab title="Markdown">
280280
````markdown
281-
```txt title="Without Word Wrap"
281+
```txt title="Without wordWrap"
282282
A very very very long line of text that may cause the code block to overflow and scroll as a result.
283283
```
284284
````
@@ -289,14 +289,14 @@ To disable scrolling and wrap overflow onto the next line, use the `wordWrap` pr
289289

290290
<Tabs>
291291
<Tab title="Example">
292-
```txt title="With Word Wrap" wordWrap
292+
```txt title="With wordWrap" wordWrap
293293
A very very very long line of text that may cause the code block to overflow and scroll as a result.
294294
```
295295
</Tab>
296296
<Tab title="Markdown">
297297
````markdown
298-
```txt title="With Word Wrap" wordWrap
299-
A very very very long line of text that may cause the codeblock to overflow and scroll as a result.
298+
```txt title="With wordWrap" wordWrap
299+
A very very very long line of text that may cause the code block to overflow and scroll as a result.
300300
```
301301
````
302302
</Tab>

fern/products/docs/pages/component-library/default-components/embed.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Fern also implements a custom component for embedding downloadable assets:
2828

2929
## Examples
3030

31-
### Video File
31+
### Video file
3232

3333
<Tabs>
3434
<Tab title="Example using `<embed>`">
@@ -57,15 +57,15 @@ Fern also implements a custom component for embedding downloadable assets:
5757
</Tab>
5858
</Tabs>
5959

60-
### PDF Document
60+
### PDF document
6161

6262
<embed src="./all-about-ferns.pdf" type="application/pdf" width="100%" height="500px" />
6363

6464
```jsx
6565
<embed src="./all-about-ferns.pdf" type="application/pdf" width="100%" height="500px" />
6666
```
6767

68-
## Common MIME Types
68+
## Common MIME types
6969

7070
| File Type | MIME Type |
7171
| ---------- | ----------------- |
@@ -81,7 +81,7 @@ Fern also implements a custom component for embedding downloadable assets:
8181
video files, consider using MP4 format for maximum compatibility.
8282
</Note>
8383

84-
## Downloadable Assets
84+
## Downloadable assets
8585

8686
Enable users to download assets from within your documentation, instead of linking to them, by using the `<Download>` component.
8787

fern/products/docs/pages/component-library/default-components/icons.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Add Font Awesome icons to your docs with customizable styles, colors and sizes u
3636
Size in 0.25rem increments (e.g., 4 = 1rem)
3737
</ParamField>
3838

39-
## Font Awesome Styles
39+
## Font Awesome styles
4040

4141
You can use any Font Awesome style by using either:
4242
- Short syntax: `icon="heart"` (defaults to solid)
@@ -69,7 +69,7 @@ You can use any Font Awesome style by using either:
6969
</Tab>
7070
</Tabs>
7171

72-
## Best Practices
72+
## Best practices
7373

7474
- Use icons consistently throughout your documentation
7575
- Keep icon sizes appropriate for their context (16-24px for inline, larger for featured items)

fern/products/docs/pages/component-library/default-components/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Components Overview'
2+
title: 'Components overview'
33
description: 'Enhance your docs with our built-in component library. Use components to create interactive and engaging documentation.'
44
---
55

fern/products/docs/pages/component-library/writing-content/markdown.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Use Markdown and MDX to add content to your Fern documentation site
55

66
## Add Markdown or MDX pages
77

8-
Add pages manually to your documentation by creating Markdown (`.md`) or MDX (`.mdx`) files. New to Markdown? See [Markdown Guide: Getting started](https://www.markdownguide.org/getting-started/).
8+
Add pages manually to your documentation by creating Markdown (`.md`) or MDX (`.mdx`) files.New to Markdown? See [Markdown Guide: Getting started](https://www.markdownguide.org/getting-started/).
99

1010
<Note>
1111
NOTE: Throughout our documentation, we refer to both Markdown and MDX as Markdown. [MDX](https://mdxjs.com/) is a version of Markdown, extended to allow the use of JSX components.
@@ -247,4 +247,4 @@ erDiagram
247247
CUSTOMER ||--o{ PLANT-ORDER : places
248248
PLANT-ORDER ||--|{ PLANT-ID : contains
249249
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
250-
```
250+
```

0 commit comments

Comments
 (0)