Skip to content

Commit 0ab133e

Browse files
committed
nit
1 parent 22b88a1 commit 0ab133e

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

fern/products/docs/pages/navigation/overview.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Every Fern Docs website has a special configuration file called `docs.yml`. Use
1212
Here's a complete example of a `docs.yml` file:
1313

1414
<CodeBlock title="An example docs.yml">
15+
1516
```yaml
1617
# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json
1718
navigation:
@@ -21,7 +22,7 @@ navigation:
2122
path: ./intro.mdx
2223
- page: Authentication
2324
path: ./auth.mdx
24-
- api: API reference
25+
- api: API Reference
2526
navbar-links:
2627
- type: secondary
2728
text: Contact support
@@ -47,7 +48,7 @@ navigation:
4748
contents:
4849
- page: My page
4950
path: ./pages/my-page.mdx
50-
- api: API reference
51+
- api: API Reference
5152
```
5253
{/* <!-- vale on --> */}
5354
If you want to add another page to an existing section, create an `.md` or `.mdx` file. Then in `docs.yml`, create a new `page` in the `contents` list for that section, providing the path to the `.md` or `.mdx` file you created. Example:
@@ -60,7 +61,7 @@ navigation:
6061
path: ./pages/my-page.mdx
6162
- page: Another page
6263
path: ./pages/another-page.mdx
63-
- api: API reference
64+
- api: API Reference
6465
```
6566

6667
To add another section, add another `section` to the `navigation`. Example:
@@ -71,7 +72,7 @@ navigation:
7172
contents:
7273
- page: My page
7374
path: ./pages/my-page.mdx
74-
- api: API reference
75+
- api: API Reference
7576
- section: Help center
7677
contents:
7778
- page: Contact us
@@ -209,7 +210,7 @@ navigation:
209210
- page: My page
210211
icon: fa-regular fa-file
211212
path: ./pages/my-page.mdx
212-
- api: API reference
213+
- api: API Reference
213214
icon: fa-regular fa-puzzle
214215
```
215216
{/* <!-- vale on --> */}
@@ -244,7 +245,7 @@ Within the navigation, you can add `tabs`. Tabs are used to group sections toget
244245
```yaml
245246
tabs:
246247
api:
247-
display-name: API reference
248+
display-name: API Reference
248249
icon: puzzle
249250
help:
250251
display-name: Help center
@@ -294,7 +295,7 @@ If you have multiple versions of your documentation, you can introduce a dropdow
294295

295296
## Product switching
296297

297-
If you have multiple products in your documentation, you can introduce a [dropdown product selector](/learn/docs/configuration/products) by creating separate product configuration files. Each product can contain its own distinct versions, tabs, sections, pages, and API references, though products can also share content.
298+
If you have multiple products in your documentation, you can introduce a [dropdown product selector](/learn/docs/configuration/products) by creating separate product configuration files. Each product can contain its own distinct versions, tabs, sections, pages, and API References, though products can also share content.
298299

299300
<CodeBlock title="docs.yml">
300301
```yaml {2-3, 7-8}

0 commit comments

Comments
 (0)