Skip to content

Commit fbdf7b7

Browse files
authored
Make various small left nav updates (#482)
1 parent e805d62 commit fbdf7b7

File tree

7 files changed

+77
-73
lines changed

7 files changed

+77
-73
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Keep the following principles in mind:
5454
- **Use [Fern’s documentation components](https://buildwithfern.com/learn/docs/writing-content/components/overview)** whenever you can.
5555
- **When editing an existing page** - Match the existing heading structure, tone, and level of detail to ensure your changes integrate as seamlessly as possible.
5656
- **Use diagrams when it makes sense** – Show, don't tell! Use [Mermaid](https://buildwithfern.com/learn/docs/writing-content/markdown#diagrams), a Markdown-like diagramming syntax, to illustrate a workflow.
57+
- [**Use sentence case**](https://developers.google.com/style/capitalization) for page and section headings.
5758

5859
> "Break any of these rules sooner than say anything outright barbarous."
5960
>

fern/products/ask-fern/ask-fern.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
navigation:
2-
- section: Getting Started
2+
- section: Getting started
33
contents:
44
- page: What is Ask Fern?
55
path: ./pages/getting-started/what-is-ask-fern.mdx
@@ -15,7 +15,7 @@ navigation:
1515
path: ./pages/features/citations.mdx
1616
- page: Custom FAQs
1717
path: ./pages/features/custom-faqs.mdx
18-
- api: API Reference
18+
- api: API reference
1919
api-name: fai
2020
icon: fa-regular fa-pro
2121
paginated: true

fern/products/cli-api-reference/cli-api-reference.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
navigation:
22
- section: CLI Reference
33
contents:
4-
- page: Get Started with Fern CLI
4+
- page: Get started with Fern CLI
55
path: ./pages/cli-get-started.mdx
66
slug: overview
7-
- page: Global Options
7+
- page: Global options
88
path: ./pages/global-options.mdx
99
slug: options
1010
- page: Commands
1111
path: ./pages/commands.mdx
1212
- changelog: ./cli-changelog
13-
- api: API Reference
13+
- api: API reference
1414
api-name: public-api
1515
icon: fa-regular fa-pro
1616
paginated: true

fern/products/docs/docs.yml

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,33 @@
11
navigation:
2-
- section: Getting Started
2+
- section: Getting started
33
contents:
44
- page: Overview
55
path: ./pages/getting-started/overview.mdx
66
- page: Quickstart
77
path: ./pages/getting-started/quickstart.mdx
8-
- page: Project Structure
8+
- page: Project structure
99
path: ./pages/getting-started/project-structure.mdx
10-
- link: Customer Showcase
10+
- link: Customer showcase
1111
href: https://buildwithfern.com/showcase#docs-customers.alldocs-features
1212
- changelog: ./pages/changelog
1313
icon: fa-regular fa-clock-rotate-left
14-
- section: Writing Content
14+
- section: Configuration
15+
contents:
16+
- page: What is docs.yml?
17+
path: ./pages/customization/what-is-docs-yml.mdx
18+
- page: Navigation
19+
path: ./pages/navigation/overview.mdx
20+
- page: Versions
21+
path: ./pages/navigation/versions.mdx
22+
- page: Products
23+
path: ./pages/navigation/products.mdx
24+
- page: Page-level settings
25+
path: ./pages/customization/frontmatter.mdx
26+
- section: Writing content
1527
contents:
16-
- page: Markdown
28+
- page: Markdown pages
1729
path: ./pages/component-library/writing-content/markdown.mdx
30+
slug: markdown
1831
- section: Components
1932
contents:
2033
- page: Overview
@@ -79,26 +92,16 @@ navigation:
7992
icon: fa-duotone fa-comment
8093
- page: Visual Editor
8194
path: ./pages/component-library/writing-content/visual-editor.mdx
82-
- page: Reusable Markdown
95+
- page: Reusable snippets
8396
path: ./pages/component-library/custom-components/reusable-markdown.mdx
84-
- page: Custom React Components
97+
slug: reusable-markdown
98+
- page: Custom React components
8599
path: ./pages/component-library/custom-components/custom-react-components.mdx
86-
- page: Conditionally Rendered Content
100+
- page: Conditionally rendered content
87101
hidden: true
88102
path: ./pages/component-library/custom-components/conditional-rendering.mdx
89-
- section: Configuration
90-
contents:
91-
- page: What is docs.yml
92-
path: ./pages/customization/what-is-docs-yml.mdx
93-
- page: Navigation
94-
path: ./pages/navigation/overview.mdx
95-
- page: Versions
96-
path: ./pages/navigation/versions.mdx
97-
- page: Products
98-
path: ./pages/navigation/products.mdx
99-
- page: Page-level settings
100-
path: ./pages/customization/frontmatter.mdx
101-
- section: Preview & Publish
103+
104+
- section: Preview & publish
102105
collapsed: true
103106
contents:
104107
- page: Previewing changes locally
@@ -112,58 +115,58 @@ navigation:
112115
- section: Customization
113116
collapsed: true
114117
contents:
115-
- page: Announcement Banner
118+
- page: Announcement banner
116119
path: ./pages/navigation/announcement-banner.mdx
117120
- page: Changelogs
118121
path: ./pages/navigation/changelogs.mdx
119-
- page: Hiding Content
122+
- page: Hiding content
120123
path: ./pages/navigation/hiding-content.mdx
121124
- page: Search
122125
path: ./pages/customization/search.mdx
123-
- page: User Feedback
126+
- page: User feedback
124127
path: ./pages/customization/user-feedback.mdx
125128
- page: Custom CSS & JS
126129
path: ./pages/component-library/custom-components/custom-css-js.mdx
127-
- section: API References
130+
- section: API references
128131
collapsed: true
129132
contents:
130-
- page: Generate API Reference
133+
- page: Generate API reference
131134
path: ./pages/api-references/generate-api-ref.mdx
132135
slug: generate-api-ref
133-
- page: SDK Snippets
136+
- page: SDK snippets
134137
path: ./pages/api-references/sdk-snippets.mdx
135-
- page: HTTP Snippets
138+
- page: HTTP snippets
136139
path: ./pages/api-references/http-snippets.mdx
137140
- section: API Explorer
138141
slug: api-explorer
139142
contents:
140143
- page: Overview
141144
path: ./pages/api-references/api-explorer.mdx
142-
- page: Auto-populate API Keys
145+
- page: Auto-populate API keys
143146
path: ./pages/api-references/autopopulate-api-key.mdx
144-
- page: Endpoint Errors
147+
- page: Endpoint errors
145148
path: ./pages/api-references/endpoint-errors.mdx
146149
- page: Audiences
147150
path: ./pages/api-references/audiences.mdx
148-
- page: Customize API Reference Layout
151+
- page: Customize API reference layout
149152
path: ./pages/api-references/customize-api-ref.mdx
150-
- page: Write Markdown in API Reference
153+
- page: Write Markdown in API reference
151154
path: ./pages/api-references/api-ref-content.mdx
152-
- page: Generate Webhook Reference
155+
- page: Generate Webhook reference
153156
path: ./pages/api-references/generate-webhook-ref.mdx
154-
- page: Multiple Server URLs
157+
- page: Multiple server URLs
155158
path: ./pages/api-references/server-urls.mdx
156159
slug: server-urls
157-
- page: Generate WebSocket Reference
160+
- page: Generate WebSocket reference
158161
path: ./pages/api-references/generate-websocket-ref.mdx
159162
slug: generate-websocket-ref
160-
- page: Generate OpenRPC Reference
163+
- page: Generate OpenRPC reference
161164
path: ./pages/api-references/generate-openrpc-ref.mdx
162165
slug: generate-openrpc-ref
163166
- section: SEO
164167
collapsed: true
165168
contents:
166-
- page: Configuring Slugs
169+
- page: Configuring slugs
167170
path: ./pages/seo/configuring-slugs.mdx
168171
- page: Redirects
169172
path: ./pages/seo/redirects.mdx
@@ -177,11 +180,11 @@ navigation:
177180
- page: Role based access control (RBAC)
178181
path: ./pages/authentication/rbac.mdx
179182
slug: rbac
180-
- page: API Key Injection
183+
- page: API key injection
181184
path: ./pages/api-references/autopopulate-api-key.mdx
182185
- page: SSO
183186
path: ./pages/authentication/sso.mdx
184-
- section: Self-Hosted
187+
- section: Self-hosted
185188
collapsed: true
186189
contents:
187190
- page: Overview
@@ -210,9 +213,9 @@ navigation:
210213
path: ./pages/integrations/support/intercom.mdx
211214
- page: Postman
212215
path: ./pages/integrations/postman.mdx
213-
- page: LaunchDarkly Feature Flags
216+
- page: LaunchDarkly feature flags
214217
path: ./pages/integrations/feature-flags.mdx
215-
- section: Developer Tools
218+
- section: Developer tools
216219
collapsed: true
217220
contents:
218221
- page: Cursor

fern/products/docs/pages/developer-tools/view-markdown.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: View Markdown
33
description: Learn how to view the Markdown underlying a documentation page, to help with tool integration and troubleshooting.
44
---
55

6-
Adding `.md` to the end of a documentation page's URL shows its source Markdown, excluding frontmatter. This works for both normal and API reference pages.
6+
Adding `.md` or `.mdx` to the end of a documentation page's URL shows its source Markdown, excluding frontmatter. This works for both normal and API reference pages.
77

88
<Tip>Displaying the page's Markdown helps with troubleshooting layout problems and makes it easier to process page content with external tools or AI agents.</Tip>
99

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
115115
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
116116
</div>
117117
<div class="text-(color:--grayscale-a11) font-light">
118-
<p>A personalized chatbot that can answer questions about your documentation.</p>
118+
<p>Get instant answers to questions about your docs from a personalized chatbot.</p>
119119
</div>
120120
</div>
121121
</div>

0 commit comments

Comments
 (0)