sentence case examples

Author: devalog

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

@@ -21,7 +21,7 @@ navigation:
         path: ./intro.mdx
       - page: Authentication
         path: ./auth.mdx
-  - api: API Reference
+  - api: API reference
 navbar-links:
   - type: secondary
     text: Contact support
@@ -40,26 +40,27 @@ In `contents`, list your pages with names and corresponding file paths. The supp
 
 A basic navigation configuration with two sections is shown below. The first section is called `Introduction` and contains a single page called `My Page`. The second section is called **API Reference**. This is a special type of section that's automatically generated by Fern, and you don't need to add any pages to it by hand. For more information, see the [Generate API Reference](/learn/docs/api-references/generate-api-ref) page.
 
+{/* <!-- vale off --> */}
 ```yaml Example navigation config
 navigation:
   - section: Introduction
     contents:
-      - page: My Page
+      - page: My page
         path: ./pages/my-page.mdx
-  - api: API Reference
+  - api: API reference
 ```
-
+{/* <!-- vale on --> */}
 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:
-
+{/* <!-- vale off --> */}
 ```yaml Example navigation config
 navigation:
   - section: Introduction
     contents:
-      - page: My Page
+      - page: My page
         path: ./pages/my-page.mdx
-      - page: Another Page
+      - page: Another page
         path: ./pages/another-page.mdx
-  - api: API Reference
+  - api: API reference
 ```
 
 To add another section, add another `section` to the `navigation`. Example:
@@ -68,34 +69,37 @@ To add another section, add another `section` to the `navigation`. Example:
 navigation:
   - section: Introduction
     contents:
-      - page: My Page
+      - page: My page
         path: ./pages/my-page.mdx
-  - api: API Reference
-  - section: Help Center
+  - api: API reference
+  - section: Help center
     contents:
-      - page: Contact Us
+      - page: Contact us
         path: contact-us.mdx
 ```
+{/* <!-- vale on --> */}
 
 ### Hiding content
 
 To hide a page or an entire section of your docs, add `hidden: true`. A hidden page or section will still be discoverable using the exact URL, but it will be excluded from search and won't be indexed.
 
+{/* <!-- vale off --> */}
 ```yaml Example navigation config with additional section {7, 10}
 navigation:
   - section: Introduction
     contents:
-      - page: My Page
+      - page: My page
         path: ./pages/my-page.mdx
-      - page: Hidden Page
+      - page: Hidden page
         hidden: true
         path: ./pages/my-hidden-page.mdx
-  - section: Hidden Sections
+  - section: Hidden sections
     hidden: true
     contents:
-      - page: Another Hidden Page
+      - page: Another hidden page
         path: ./pages/also-hidden.mdx
 ```
+{/* <!-- vale on --> */}
 
 ### Section and page availability
 
@@ -105,17 +109,17 @@ Options are: `stable`, `generally-available`, `in-development`, `pre-release`, `
 
 ```yaml Availability {3, 11, 14}
 navigation:
-  - section: Developer Resources
+  - section: Developer resources
     availability: generally-available
     contents:
-      - page: Code Examples # Inherits generally-available
+      - page: Code examples # Inherits generally-available
         path: ./pages/code-examples.mdx
-      - page: CLI Tools # Inherits generally-available
+      - page: CLI tools # Inherits generally-available
         path: ./pages/cli-tools.mdx
-      - page: Testing Framework
+      - page: Testing framework
         path: ./pages/testing-framework.mdx
         availability: beta # Overrides section-level availability
-      - page: Performance Monitoring
+      - page: Performance monitoring
         path: ./pages/performance-monitoring.mdx
         availability: in-development # Overrides section-level availability
 ```
@@ -127,20 +131,22 @@ navigation:
 
 To add an overview page to a section, add a `path` property to the section.
 
+{/* <!-- vale off --> */}
 ```yaml Example section with an overview {7}
 navigation:
   - section: Introduction
     contents:
-      - page: My Page
+      - page: My page
         path: ./pages/my-page.mdx
       - section: Guides
         path: ./pages/guide-overview.mdx
         contents:
-          - page: Simple Guide
+          - page: Simple guide
             path: ./pages/guides/simple.mdx
-          - page: Complex Guide
+          - page: Complex guide
             path: ./pages/guides/complex.mdx
 ```
+{/* <!-- vale on --> */}
 
 ## Nested sections
 
@@ -152,15 +158,15 @@ navigation:
     layout:
       - section: Learn
         contents:
-          - section: Key Concepts
+          - section: Key concepts
             contents:
               - page: Embeddings
                 path: ./docs/pages/embeddings.mdx
-              - page: Prompt Engineering
+              - page: Prompt engineering
                 path: ./docs/pages/prompts.mdx
           - section: Generation
             contents:
-              - page: Command Nightly
+              - page: Command nightly
                 path: ./docs/pages/command.mdx
               - page: Likelihood
                 path: ./docs/pages/likelihood.mdx
@@ -177,11 +183,11 @@ This helps keep the navigation tidy when you have many sections or want to highl
 
 ```yaml {7} Example config with collapsed section
 navigation:
-  - section: Getting Started
+  - section: Getting started
     contents:
       - page: Introduction
         path: ./pages/intro.mdx
-  - section: Advanced Topics
+  - section: Advanced topics
     collapsed: true
     contents:
       - page: Custom CSS
@@ -194,31 +200,35 @@ navigation:
 
 For icons to appear next to sections and pages, add the `icon` key. The value should be a valid [Font Awesome icon](https://fontawesome.com/icons) name. Pro and Brand Icons from Font Awesome are supported.
 
+{/* <!-- vale off --> */}
 ```yaml Example navigation config with icons
 navigation:
   - section: Home
     icon: fa-regular fa-home
     contents:
-      - page: My Page
+      - page: My page
         icon: fa-regular fa-file
         path: ./pages/my-page.mdx
-  - api: API Reference
+  - api: API reference
     icon: fa-regular fa-puzzle
 ```
+{/* <!-- vale on --> */}
 
 ## Links
 
 You can add a link to an external page within your sidebar navigation with the following configuration:
 
+{/* <!-- vale off --> */}
 ```yaml title="docs.yml"
 navigation:
   - section: Home
     contents:
       - page: Introduction
         path: ./intro.mdx
-      - link: Our YouTube Channel
+      - link: Our YouTube channel
         href: https://www.youtube.com/
 ```
+{/* <!-- vale on --> */}
 
 <Frame>
   <img src="./external-link.png" alt="An external link within navigation" />
@@ -229,13 +239,15 @@ navigation:
 Within the navigation, you can add `tabs`. Tabs are used to group sections together. The example below shows tabs for `Help Center`, `API Reference`, and an external link to `Github`. Each tab has a `title` and `icon`. [Browse the icons available](https://fontawesome.com/icons) from Font Awesome. Pro and Brand Icons are supported.
 
 <CodeBlock title="docs.yml">
+{/* <!-- vale off --> */}
+
 ```yaml
 tabs: 
   api: 
-    display-name: API Reference
+    display-name: API reference
     icon: puzzle
   help:
-    display-name: Help Center
+    display-name: Help center
     icon: home
   github:
     display-name: GitHub
@@ -247,17 +259,18 @@ tabs:
     layout: 
       - section: Introduction
           contents: 
-            - page: My Page
+            - page: My page
                 path: my-page.mdx
         - api: API Reference   
   - tab: help
     layout: 
-      - section: Help Center
+      - section: Help center
         contents: 
-          - page: Contact Us
+          - page: Contact us
               path: contact-us.mdx
   - tab: github
 ```
+{/* <!-- vale on --> */}
 </CodeBlock>
 
 Here's an example of what the Tabs implementation looks like: