Skip to content

Commit a983ab7

Browse files
committed
standardize intro sentences
1 parent b58c5f7 commit a983ab7

File tree

17 files changed

+30
-49
lines changed

17 files changed

+30
-49
lines changed

.vale/styles/FernStyles/Acronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,4 @@ exceptions:
8888
- JPEG
8989
- RPG
9090
- MIME
91+
- PNG

.vale/styles/FernStyles/Headings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,4 @@ exceptions:
115115
- YAML
116116
- fern.config.json
117117
- Font Awesome
118+
- Card Group

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ 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.
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

88
<div className="highlight-frame">
99
<AccordionGroup>
@@ -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

6262
```jsx
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
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Anchor
33
description: Create linkable anchors for paragraphs, tables, and other content without headings
44
---
55

6-
The Anchor component creates links to specific paragraphs, tables, and other sections of content that don't have headings.
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>
99
Headings automatically generate anchor links based on their text content, so you don't need to use the `<Anchor>` component for headings.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: 'Button'
33
description: 'Interactive button component with multiple variants and intents'
44
---
55

6-
The `Button` component creates a flexible way to create 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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: 'Callouts'
33
description: 'Highlight important information, warnings, or tips in your documentation.'
44
---
55

6-
Callouts help highlight important information, warnings, or tips in your documentation. They provide visual emphasis through distinct styling and icons to make key messages stand out to readers.
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.
77

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: 'Cards'
33
description: 'Use cards to display content in a box'
44
---
55

6-
Cards are container components that group related content and actions together. They provide a flexible way to present information with optional elements like icons, titles, and links in a visually distinct box.
6+
Cards are container components that group related content and actions in a visually distinct box. Optional elements include icons, titles, and links.
77

8-
You can use individual cards or arrange multiple cards in a responsive grid layout using the use the `CardGroup` component. Groups of cards are useful for organizing related content like feature lists, navigation options, or step-by-step guides.
8+
You can use individual cards or arrange multiple cards in a responsive grid layout using the `CardGroup` component. Card groups are useful for organizing feature lists, navigation options, or step-by-step guides.
99

1010
## Usage
1111

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'Learn how to enhance your documentation with customizable code blo
44
max-toc-depth: 2
55
---
66

7-
Use code blocks to showcase code examples with syntax highlighting powered by [Shiki](https://shiki.matsu.io/). Code blocks support features like line highlighting, focusing, titles, and deep linking to make your code examples more readable and interactive.
7+
The Code Block component displays code examples with syntax highlighting powered by [Shiki](https://shiki.matsu.io/). Code Blocks support line highlighting, focusing, titles, and deep linking to make your code examples more readable and interactive.
88

99
## Usage
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Embedded assets and files"
33
description: "Embed local assets like PDFs, videos, and more in your documentation"
44
---
55

6-
Use native HTML5 tags to embed local assets like PDFs, videos, and more in your documentation.
6+
Embed local assets like PDFs, videos, and other media directly in your documentation using native HTML5 tags. This allows you to include rich content without relying on external hosting.
77

88
<Info title="Supported tags">
99
Fern supports using the `<embed src="..." />` tag to embed [external content](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/embed) and the `<source src="..." />` tag to embed [media or image sources](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/source).

fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@ title: 'Endpoint Schema Snippet'
33
description: 'Reference an endpoint schema from your API Reference'
44
---
55

6-
Use the `EndpointSchemaSnippet` component to reference an endpoint's schema from
7-
your API Reference.
8-
9-
Passing no selector will render the entire schema. If you want to reference a particular piece of the schema, you can use the optional `selector` prop
10-
to specify the path to the schema you want to reference. The available selectors are: `request`,
11-
`request.path`, `request.query`, `request.body`, `response`, and `response.body`.
6+
The EndpointSchemaSnippet component displays endpoint schemas from your API Reference. By default, it renders the complete schema, or you can use the `selector` prop to display specific parts like request body, response, path parameters, or query parameters.
127

8+
<Note>
9+
Markdown-rich field descriptions aren't yet supported and will display as plain text. See the [Request path](#request-path) example below.
10+
</Note>
1311

1412
## Usage
1513

@@ -73,9 +71,3 @@ Passing `response` as the selector will only render the response schema.
7371
```jsx Markdown
7472
<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response.body" />
7573
```
76-
77-
<Warning>
78-
The EndpointSchemaSnippet component doesn't yet support rendering markdown-rich field descriptions.
79-
80-
See [request.endpoint.path](/learn/docs/writing-content/components/schema-snippet#request.endpoint.path) above for an example of a markdown-rich description that does not yet render as markdown.
81-
</Warning>

0 commit comments

Comments
 (0)