Skip to content

Commit e57076a

Browse files
committed
casing and other nits
1 parent decd646 commit e57076a

22 files changed

+128
-128
lines changed

fern/products/docs/docs.yml

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,69 +35,81 @@ navigation:
3535
- page: Overview
3636
path: ./pages/component-library/default-components/overview.mdx
3737
icon: fa-duotone fa-book
38-
- page: Accordions
38+
- page: Accordion
3939
path: ./pages/component-library/default-components/accordions.mdx
4040
icon: fa-duotone fa-chevron-down
41+
slug: accordions
4142
- page: Anchor
4243
path: ./pages/component-library/default-components/anchor.mdx
4344
icon: fa-duotone fa-link
4445
- page: Aside
4546
path: ./pages/component-library/default-components/aside.mdx
4647
icon: fa-regular fa-comment-dots
47-
- page: Badges
48+
- page: Badge
4849
path: ./pages/component-library/default-components/badges.mdx
4950
icon: fa-regular fa-ribbon
51+
slug: badges
5052
- page: Button
5153
path: ./pages/component-library/default-components/button.mdx
5254
icon: fa-duotone fa-arrow-pointer
53-
- page: Callouts
55+
- page: Callout
5456
path: ./pages/component-library/default-components/callouts.mdx
5557
icon: fa-duotone fa-exclamation-triangle
56-
- page: Cards
58+
slug: callouts
59+
- page: Card
5760
path: ./pages/component-library/default-components/cards.mdx
5861
icon: fa-duotone fa-id-card
59-
- page: Code Blocks
62+
slug: cards
63+
- page: Code block
6064
path: ./pages/component-library/default-components/code-blocks.mdx
6165
icon: fa-duotone fa-code
66+
slug: code-blocks
6267
- page: Embed
6368
path: ./pages/component-library/default-components/embed.mdx
6469
icon: fa-duotone fa-window-restore
65-
- page: Endpoint Request Snippet
70+
- page: Endpoint request snippet
6671
path: ./pages/component-library/default-components/endpoint-request-snippet.mdx
6772
icon: fa-duotone fa-arrow-up
6873
slug: request-snippet
69-
- page: Endpoint Response Snippet
74+
- page: Endpoint response snippet
7075
path: ./pages/component-library/default-components/endpoint-response-snippet.mdx
7176
icon: fa-duotone fa-arrow-down
7277
slug: response-snippet
73-
- page: Endpoint Schema Snippet
78+
- page: Endpoint schema snippet
7479
path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx
7580
icon: fa-duotone fa-sitemap
7681
slug: schema-snippet
77-
- page: Frames
82+
- page: Frame
7883
path: ./pages/component-library/default-components/frames.mdx
7984
icon: fa-duotone fa-window-maximize
80-
- page: Icons
85+
slug: frames
86+
- page: Icon
8187
path: ./pages/component-library/default-components/icons.mdx
8288
icon: fa-duotone fa-icons
83-
- page: Parameter Fields
89+
slug: icons
90+
- page: Parameter field
8491
path: ./pages/component-library/default-components/parameter-fields.mdx
8592
icon: fa-duotone fa-list
86-
- page: Runnable Endpoint
93+
slug: parameter-fields
94+
- page: Runnable endpoint
8795
path: ./pages/component-library/default-components/runnable-endpoint.mdx
8896
icon: fa-duotone fa-play-circle
89-
- page: Steps
97+
- page: Step
9098
path: ./pages/component-library/default-components/steps.mdx
9199
icon: fa-duotone fa-list-ol
92-
- page: Sticky tables
100+
slug: steps
101+
- page: Sticky table
93102
path: ./pages/component-library/default-components/sticky-tables.mdx
94103
icon: fa-duotone fa-table
95-
- page: Tabs
104+
slug: sticky-tables
105+
- page: Tab
96106
path: ./pages/component-library/default-components/tabs.mdx
97107
icon: fa-duotone fa-folder-open
98-
- page: Tooltips
108+
slug: tabs
109+
- page: Tooltip
99110
path: ./pages/component-library/default-components/tooltips.mdx
100111
icon: fa-duotone fa-comment
112+
slug: tooltips
101113
- page: Fern Editor
102114
path: ./pages/component-library/writing-content/visual-editor.mdx
103115
slug: fern-editor

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: Accordions
33
description: Display expandable/collapsible options with browser search functionality
44
---
55

6-
The Accordion component creates expandable sections with searchable, SEO-friendly content that remains accessible even when collapsed. Use accordions for FAQs, documentation sections, settings panels, or any content where progressive disclosure improves readability.
6+
The `<Accordion>` component creates expandable sections with searchable, SEO-friendly content that remains accessible even when collapsed. Use accordions for FAQs, documentation sections, settings panels, or any content where progressive disclosure improves readability.
77

8-
You can use single Accordions or group multiple Accordions together with AccordionGroup.
8+
You can use single accordions or group multiple accordions together with `<AccordionGroup>`.
99

1010
## Usage
1111

@@ -20,7 +20,7 @@ You can use single Accordions or group multiple Accordions together with Accordi
2020
</AccordionGroup>
2121
</div>
2222

23-
```jsx Markdown syntax
23+
```jsx Markdown
2424
<AccordionGroup>
2525
<Accordion title="Section 1" defaultOpen={true}>
2626
Content for section 1, expanded by default
@@ -33,7 +33,7 @@ You can use single Accordions or group multiple Accordions together with Accordi
3333

3434
## Variants
3535

36-
Within each Accordion, you can embed images, videos, and other components (Callouts, Code Blocks, etc) within accordions for rich interactive content.
36+
Within each accordion, you can embed images, videos, and other components (callouts, code blocks, etc) within accordions for rich interactive content.
3737

3838
### Multimedia
3939

@@ -43,7 +43,7 @@ Within each Accordion, you can embed images, videos, and other components (Callo
4343
</Frame>
4444
</Accordion>
4545

46-
```jsx
46+
```jsx Markdown
4747
<Accordion title="Text content with multimedia">
4848
<Frame caption="Sample image">
4949
<img src="https://images.pexels.com/photos/1867601/pexels-photo-1867601.jpeg" alt="A sample image" />
@@ -55,14 +55,14 @@ Within each Accordion, you can embed images, videos, and other components (Callo
5555

5656
<Accordion title="Nested components">
5757
<Note>
58-
Here's a Callout nested in an Accordion
58+
Here's a callout nested in an accordion
5959
</Note>
6060
</Accordion>
6161

62-
```jsx
62+
```jsx Markdown
6363
<Accordion title="Nested components">
6464
<Note>
65-
Here's a Callout nested in an Accordion
65+
Here's a callout nested in an accordion
6666
</Note>
6767
</Accordion>
6868
```
@@ -73,7 +73,7 @@ Within each Accordion, you can embed images, videos, and other components (Callo
7373
Use the `defaultOpen` property to have specific accordions expanded by default when the page loads. This is useful for highlighting important information or frequently accessed content.
7474
</Accordion>
7575
76-
```jsx
76+
```jsx Markdown
7777
<Accordion title='Accordion open by default' defaultOpen={true}>
7878
Use the `defaultOpen` property to have specific accordions expanded by default when the page loads. This is useful for highlighting important information or frequently accessed content.
7979
</Accordion>

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Anchor
2+
title: Anchors
33
description: Create linkable anchors for paragraphs, tables, and other content without headings
44
---
55

6-
The Anchor component creates direct links to specific content like paragraphs, tables, and code blocks. Use anchors when you need to reference non-heading content that doesn't automatically generate its own link.
6+
The `<Anchor>` component creates direct links to specific content like paragraphs, tables, and code blocks. Use anchors when you need to reference non-heading content that doesn't automatically generate its own link.
77

88
<Note>
9-
Headings automatically generate anchor links based on their text content, so you don't need to use the `<Anchor>` component for headings.
9+
Headings automatically generate anchor links based on their text content, so you don't need to use the anchor component for headings.
1010
</Note>
1111

1212
## Usage
@@ -17,7 +17,7 @@ Wrap your content with the `<Anchor>` tag and assign it a custom anchor ID, whic
1717
<Anchor id="data">This sentence has a custom anchor named `#data`</Anchor>. You can access it via this URL: https://buildwithfern.com/learn/docs/writing-content/components/anchor#data.
1818
</div>
1919

20-
```jsx Markdown syntax
20+
```jsx Markdown
2121
<Anchor id="data">This sentence has a custom anchor named `#data`</Anchor>. You can access it via this URL: https://buildwithfern.com/learn/docs/writing-content/components/anchor#data.
2222
```
2323

@@ -37,7 +37,7 @@ Wrap your content with the `<Anchor>` tag and assign it a custom anchor ID, whic
3737

3838
You can link directly to the [API endpoints table](#api-endpoints).
3939

40-
```jsx
40+
```jsx Markdown
4141
<Anchor id="api-endpoints">
4242

4343
| Endpoint | Method | Description |
@@ -68,7 +68,7 @@ def water_plant(plant_id, amount):
6868

6969
Reference the [watering code example](#example-code) in your implementation.
7070

71-
````jsx
71+
````jsx Markdown
7272
<Anchor id="example-code">
7373

7474
```python

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: 'Aside'
2+
title: 'Asides'
33
description: 'Push any content inside the Aside component to the right of the page in a sticky container'
44
---
55

6-
The Aside component creates a sticky container that floats content to the right of your page. Use it to showcase code examples, API snippets, or any supplementary content that should stay visible as users scroll.
6+
The `<Aside>` component creates a sticky container that floats content to the right of your page. Use it to showcase code examples, API snippets, or any supplementary content that should stay visible as users scroll.
77

88
<Aside>
99
<EndpointRequestSnippet endpoint='POST /chat/{domain}' />
1010
</Aside>
1111

1212
## Usage
1313

14-
```jsx Markdown syntax
14+
```jsx Markdown
1515
<Aside>
1616
<EndpointRequestSnippet endpoint='POST /chat/{domain}' />
1717
</Aside>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Badges
33
description: Display small labels for status, versions, and metadata inline with your content.
44
---
55

6-
Use the `Badge` component to display small pieces of information, such as status indicators, categories, versions, or release dates. To display longer notes, use the [Callouts component](/docs/writing-content/components/callouts).
6+
Use the `<Badge>` component to display small pieces of information, such as status indicators, categories, versions, or release dates. To display longer notes, use [callouts](/docs/writing-content/components/callouts).
77

88
## Usage
99

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: 'Button'
2+
title: 'Buttons'
33
description: 'Interactive button component with multiple variants and intents'
44
---
55

6-
The Button component renders interactive buttons with various styles, sizes, and intents.
6+
The `<Button>` component renders interactive buttons with various styles, sizes, and intents.
77

88
## Usage
99

@@ -29,20 +29,20 @@ The Button component renders interactive buttons with various styles, sizes, and
2929

3030
<div className="space-y-4">
3131
<div className="space-x-2">
32-
<Button intent="primary">Primary Button</Button>
33-
<Button intent="success">Success Button</Button>
34-
<Button intent="warning">Warning Button</Button>
35-
<Button intent="danger">Danger Button</Button>
36-
<Button intent="none">Plain Button</Button>
32+
<Button intent="primary">Primary button</Button>
33+
<Button intent="success">Success button</Button>
34+
<Button intent="warning">Warning button</Button>
35+
<Button intent="danger">Danger button</Button>
36+
<Button intent="none">Plain button</Button>
3737
</div>
3838
</div>
3939

40-
```jsx
41-
<Button intent="primary">Primary Button</Button>
42-
<Button intent="success">Success Button</Button>
43-
<Button intent="warning">Warning Button</Button>
44-
<Button intent="danger">Danger Button</Button>
45-
<Button intent="none">Plain Button</Button>
40+
```jsx Markdown
41+
<Button intent="primary">Primary button</Button>
42+
<Button intent="success">Success button</Button>
43+
<Button intent="warning">Warning button</Button>
44+
<Button intent="danger">Danger button</Button>
45+
<Button intent="none">Plain button</Button>
4646
```
4747
### Styles
4848

@@ -52,7 +52,7 @@ The Button component renders interactive buttons with various styles, sizes, and
5252
<Button intent="warning" mono>Monospaced</Button>
5353
</div>
5454

55-
```jsx
55+
```jsx Markdown
5656
<Button intent="success" outlined large rounded>Large, outlined, rounded</Button>
5757
<Button intent="success" minimal>Minimal</Button>
5858
<Button intent="warning" mono>Monospaced</Button>
@@ -66,7 +66,7 @@ The Button component renders interactive buttons with various styles, sizes, and
6666
<Button large>Large Button</Button>
6767
</div>
6868

69-
```jsx
69+
```jsx Markdown
7070
<Button small>Small Button</Button>
7171
<Button>Normal Button</Button>
7272
<Button large>Large Button</Button>
@@ -80,7 +80,7 @@ The Button component renders interactive buttons with various styles, sizes, and
8080
<Button icon="star" rightIcon="arrow-right">Favorite</Button>
8181
</div>
8282

83-
```jsx
83+
```jsx Markdown
8484
<Button icon="download">Download</Button>
8585
<Button rightIcon="arrow-right">Continue</Button>
8686
<Button icon="star" rightIcon="arrow-right">Favorite</Button>
@@ -93,7 +93,7 @@ The Button component renders interactive buttons with various styles, sizes, and
9393
<Button disabled>Disabled Button</Button>
9494
</div>
9595

96-
```jsx
96+
```jsx Markdown
9797
<Button href="/learn/docs/getting-started/overview">Link Button</Button>
9898
<Button disabled>Disabled Button</Button>
9999
```

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

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@ title: 'Callouts'
33
description: 'Highlight important information, warnings, or tips in your documentation.'
44
---
55

6-
Callouts highlight important information, warnings, or tips in your documentation. Use Callouts to emphasize critical details that readers shouldn't miss, such as breaking changes, prerequisites, or helpful best practices.
6+
The `<Callout>` component highlights important information, warnings, or tips in your documentation. Use callouts to emphasize critical details that readers shouldn't miss, such as breaking changes, prerequisites, or helpful best practices.
77

8-
To display very short pieces of information like status indicators and version numbers, use the [Badges component](/docs/writing-content/components/badges).
8+
To display very short pieces of information like status indicators and version numbers, use [badges](/docs/writing-content/components/badges).
99

1010
## Usage
1111

1212
<div className="highlight-frame">
13-
<Note>This adds a note in the content</Note>
13+
<Note>This adds a note in your documentation.</Note>
1414
</div>
1515

1616
```jsx Markdown
17-
<Note>This adds a note in the content</Note>
17+
<Note>This adds a note in your documentation.</Note>
1818
```
1919

2020
## Variants
@@ -39,30 +39,15 @@ To display very short pieces of information like status indicators and version n
3939
<Check>This shows a checked status</Check>
4040
```
4141

42-
### Tip callouts
43-
44-
<Tip>This suggests a helpful tip</Tip>
45-
<Check>This shows a checked status</Check>
46-
47-
```jsx Markdown
48-
<Warning>This raises a warning to watch out for</Warning>
49-
<Success>This indicates a successful operation or positive outcome</Success>
50-
<Error>This indicates a potential error</Error>
51-
<Info>This draws attention to important information</Info>
52-
<Launch>This celebrates a product launch or other announcement</Launch>
53-
<Tip>This suggests a helpful tip</Tip>
54-
<Check>This shows a checked status</Check>
55-
```
56-
5742
### Custom icon
5843

5944
<Warning title="Example callout" icon="skull-crossbones">
60-
This Callout uses a title and a custom Font Awesome icon.
45+
This callout uses a title and a custom Font Awesome icon.
6146
</Warning>
6247

6348
```jsx Markdown
6449
<Warning title="Example callout" icon="skull-crossbones">
65-
This Callout uses a title and a custom Font Awesome icon.
50+
This callout uses a title and a custom Font Awesome icon.
6651
</Warning>
6752
```
6853

@@ -73,11 +58,11 @@ This Callout uses a title and a custom Font Awesome icon.
7358
</ParamField>
7459

7560
<ParamField path="title" type="string" required={false}>
76-
The title of your Callout
61+
The title of your callout
7762
</ParamField>
7863

7964
<ParamField path="icon" type="string | ReactElement" required={false}>
80-
The icon of your Callout. Can be:
65+
The icon of your callout. Can be:
8166
- A [Font Awesome](https://fontawesome.com/icons) icon name
8267
- A React element
8368
- If not specified, uses a default icon based on the intent:

0 commit comments

Comments
 (0)