From 51be1080dd0e8a2a9fd7930b17c09284e2b800ab Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 17:08:17 +0000 Subject: [PATCH 01/14] Convert docs product headings and titles to sentence case Co-Authored-By: Devin Logan --- fern/products/docs/docs.yml | 18 +++++++++--------- .../default-components/accordion-groups.mdx | 6 +++--- .../default-components/card-groups.mdx | 2 +- .../default-components/code-blocks.mdx | 4 ++-- .../default-components/embed.mdx | 6 +++--- .../endpoint-request-snippet.mdx | 2 +- .../endpoint-response-snippet.mdx | 2 +- .../endpoint-schema-snippet.mdx | 2 +- .../default-components/icons.mdx | 4 ++-- .../default-components/overview.mdx | 2 +- .../default-components/runnable-endpoint.mdx | 2 +- .../default-components/steps.mdx | 4 ++-- .../writing-content/visual-editor.mdx | 2 +- 13 files changed, 28 insertions(+), 28 deletions(-) diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 300965ea..9590d898 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -38,7 +38,7 @@ navigation: - page: Accordions path: ./pages/component-library/default-components/accordions.mdx icon: fa-duotone fa-chevron-down - - page: Accordion Groups + - page: Accordion groups path: ./pages/component-library/default-components/accordion-groups.mdx icon: fa-duotone fa-chevrons-down - page: Aside @@ -56,28 +56,28 @@ navigation: - page: Cards path: ./pages/component-library/default-components/cards.mdx icon: fa-duotone fa-id-card - - page: Card Groups + - page: Card groups path: ./pages/component-library/default-components/card-groups.mdx icon: fa-duotone fa-grid-2 - - page: Code Blocks + - page: Code blocks path: ./pages/component-library/default-components/code-blocks.mdx icon: fa-duotone fa-code - page: Embed path: ./pages/component-library/default-components/embed.mdx icon: fa-duotone fa-window-restore - - page: Endpoint Request Snippet + - page: Endpoint request snippet path: ./pages/component-library/default-components/endpoint-request-snippet.mdx icon: fa-duotone fa-arrow-up slug: request-snippet - - page: Endpoint Response Snippet + - page: Endpoint response snippet path: ./pages/component-library/default-components/endpoint-response-snippet.mdx icon: fa-duotone fa-arrow-down slug: response-snippet - - page: Endpoint Schema Snippet + - page: Endpoint schema snippet path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx icon: fa-duotone fa-sitemap slug: schema-snippet - - page: Runnable Endpoint + - page: Runnable endpoint path: ./pages/component-library/default-components/runnable-endpoint.mdx icon: fa-duotone fa-play-circle - page: Frames @@ -86,7 +86,7 @@ navigation: - page: Icons path: ./pages/component-library/default-components/icons.mdx icon: fa-duotone fa-icons - - page: Parameter Fields + - page: Parameter fields path: ./pages/component-library/default-components/parameter-fields.mdx icon: fa-duotone fa-list - page: Steps @@ -101,7 +101,7 @@ navigation: - page: Tooltips path: ./pages/component-library/default-components/tooltips.mdx icon: fa-duotone fa-comment - - page: Fern Editor + - page: Fern editor path: ./pages/component-library/writing-content/visual-editor.mdx slug: fern-editor - page: Reusable snippets diff --git a/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx b/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx index b977489a..4201eb10 100644 --- a/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx +++ b/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx @@ -1,5 +1,5 @@ --- -title: 'Accordion Groups' +title: 'Accordion groups' description: 'Display expandable/collapsible options that reveal more information with improved search functionality' --- @@ -30,11 +30,11 @@ Accordion Groups allow you to organize content into collapsible sections, making -### Enhanced Search Functionality +### Enhanced search functionality The recent update to our Accordion component improves content discoverability by allowing users to search through all content, including collapsed sections, using the browser's search function (Cmd+F / Ctrl+F). -### Usage Examples +### Usage examples Here are some examples of how to use the Accordion Group component: diff --git a/fern/products/docs/pages/component-library/default-components/card-groups.mdx b/fern/products/docs/pages/component-library/default-components/card-groups.mdx index cb30305d..3093aee1 100644 --- a/fern/products/docs/pages/component-library/default-components/card-groups.mdx +++ b/fern/products/docs/pages/component-library/default-components/card-groups.mdx @@ -1,5 +1,5 @@ --- -title: 'Card Groups' +title: 'Card groups' description: 'Show cards side by side in a grid format' --- diff --git a/fern/products/docs/pages/component-library/default-components/code-blocks.mdx b/fern/products/docs/pages/component-library/default-components/code-blocks.mdx index 76a34af2..d4e8f6a2 100644 --- a/fern/products/docs/pages/component-library/default-components/code-blocks.mdx +++ b/fern/products/docs/pages/component-library/default-components/code-blocks.mdx @@ -1,5 +1,5 @@ --- -title: 'Code Blocks' +title: 'Code blocks' description: 'Learn how to enhance your documentation with customizable code blocks featuring syntax highlighting, line highlighting, focusing, and more.' --- @@ -343,7 +343,7 @@ and a maximum height. -## Code Blocks with Tabs +## Code blocks with tabs The `CodeBlocks` component allows you to display multiple code blocks in a tabbed interface. diff --git a/fern/products/docs/pages/component-library/default-components/embed.mdx b/fern/products/docs/pages/component-library/default-components/embed.mdx index fa7aaa40..c0d97db8 100644 --- a/fern/products/docs/pages/component-library/default-components/embed.mdx +++ b/fern/products/docs/pages/component-library/default-components/embed.mdx @@ -1,5 +1,5 @@ --- -title: "Embedded Assets and Files" +title: "Embedded assets and files" description: "Embed local assets like PDFs, videos, and more in your documentation" --- @@ -65,7 +65,7 @@ Fern also implements a custom component for embedding downloadable assets: ``` -## Common MIME Types +## Common MIME types | File Type | MIME Type | | ---------- | ----------------- | @@ -81,7 +81,7 @@ Fern also implements a custom component for embedding downloadable assets: video files, consider using MP4 format for maximum compatibility. -## Downloadable Assets +## Downloadable assets Enable users to download assets from within your documentation, instead of linking to them, by using the `` component. diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx index 8fa68adb..6b09b974 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx @@ -1,5 +1,5 @@ --- -title: 'Endpoint Request Snippet' +title: 'Endpoint request snippet' description: 'Reference an endpoint request from your API Reference' --- diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx index 197f78ba..625ec78d 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx @@ -1,5 +1,5 @@ --- -title: 'Endpoint Response Snippet' +title: 'Endpoint response snippet' description: 'Reference an endpoint response from your API Reference' --- diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx index f5023a5e..042ab3e7 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx @@ -1,5 +1,5 @@ --- -title: 'Endpoint Schema Snippet' +title: 'Endpoint schema snippet' description: 'Reference an endpoint schema from your API Reference' --- diff --git a/fern/products/docs/pages/component-library/default-components/icons.mdx b/fern/products/docs/pages/component-library/default-components/icons.mdx index 95c07f75..c6f98e71 100644 --- a/fern/products/docs/pages/component-library/default-components/icons.mdx +++ b/fern/products/docs/pages/component-library/default-components/icons.mdx @@ -36,7 +36,7 @@ Add Font Awesome icons to your docs with customizable styles, colors and sizes u Size in 0.25rem increments (e.g., 4 = 1rem) -## Font Awesome Styles +## Font Awesome styles You can use any Font Awesome style by using either: - Short syntax: `icon="heart"` (defaults to solid) @@ -69,7 +69,7 @@ You can use any Font Awesome style by using either: -## Best Practices +## Best practices - Use icons consistently throughout your documentation - Keep icon sizes appropriate for their context (16-24px for inline, larger for featured items) diff --git a/fern/products/docs/pages/component-library/default-components/overview.mdx b/fern/products/docs/pages/component-library/default-components/overview.mdx index d0e02d7a..210e86f7 100644 --- a/fern/products/docs/pages/component-library/default-components/overview.mdx +++ b/fern/products/docs/pages/component-library/default-components/overview.mdx @@ -1,5 +1,5 @@ --- -title: 'Components Overview' +title: 'Components overview' description: 'Enhance your docs with our built-in component library. Use components to create interactive and engaging documentation.' --- diff --git a/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx b/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx index 86416ca7..b9ce3eaf 100644 --- a/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx +++ b/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx @@ -1,5 +1,5 @@ --- -title: Runnable Endpoint +title: Runnable endpoint description: Test API endpoints directly from your documentation with an interactive request builder. --- diff --git a/fern/products/docs/pages/component-library/default-components/steps.mdx b/fern/products/docs/pages/component-library/default-components/steps.mdx index 60156a69..9a093385 100644 --- a/fern/products/docs/pages/component-library/default-components/steps.mdx +++ b/fern/products/docs/pages/component-library/default-components/steps.mdx @@ -61,13 +61,13 @@ The Steps component helps organize sequential content with automatic numbering, ## Properties -### Steps Properties +### Steps properties Whether to include the steps in the table of contents. Defaults to `false`. -### Step Properties +### Step properties Optional title for the step diff --git a/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx b/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx index fb0cf942..c36b0119 100644 --- a/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx +++ b/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx @@ -1,5 +1,5 @@ --- -title: Fern Editor +title: Fern editor description: Update your docs visually with a GitHub-backed workflow that creates pull requests. --- From c18895ddccc2d01094420aef0f34e5150517e983 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 17:26:59 +0000 Subject: [PATCH 02/14] Convert headings and titles to sentence case in docs product section - Fixed all changelog files (2024-2025) - Fixed API reference files (api-explorer, generate-openrpc-ref, http-snippets, sdk-snippets, server-urls) - Fixed component-library files (embed) - Fixed customization files (search) - Fixed integrations files (feature-flags) - Fixed navigation files (overview) - Preserved Vale exceptions (API Reference, API Explorer, Fern, GitHub, Markdown, etc.) Co-Authored-By: Devin Logan --- .../docs/pages/api-references/api-explorer.mdx | 4 ++-- .../api-references/autopopulate-api-key.mdx | 2 +- .../api-references/generate-openrpc-ref.mdx | 8 ++++---- .../docs/pages/api-references/http-snippets.mdx | 10 +++++----- .../docs/pages/api-references/sdk-snippets.mdx | 2 +- .../docs/pages/api-references/server-urls.mdx | 4 ++-- .../products/docs/pages/changelog/2024-01-24.mdx | 10 +++++----- .../products/docs/pages/changelog/2024-02-22.mdx | 12 ++++++------ .../products/docs/pages/changelog/2024-03-24.mdx | 6 +++--- .../products/docs/pages/changelog/2024-04-20.mdx | 6 +++--- .../products/docs/pages/changelog/2024-05-22.mdx | 4 ++-- .../products/docs/pages/changelog/2024-06-25.mdx | 10 +++++----- .../products/docs/pages/changelog/2024-07-30.mdx | 2 +- .../products/docs/pages/changelog/2024-08-20.mdx | 8 ++++---- .../products/docs/pages/changelog/2024-09-24.mdx | 2 +- .../products/docs/pages/changelog/2024-10-31.mdx | 6 +++--- .../products/docs/pages/changelog/2024-11-27.mdx | 4 ++-- .../products/docs/pages/changelog/2024-12-30.mdx | 6 +++--- .../products/docs/pages/changelog/2025-01-21.mdx | 4 ++-- .../products/docs/pages/changelog/2025-05-22.mdx | 4 ++-- .../products/docs/pages/changelog/2025-06-05.mdx | 2 +- .../products/docs/pages/changelog/2025-10-17.mdx | 4 ++-- .../default-components/embed.mdx | 4 ++-- .../products/docs/pages/customization/search.mdx | 4 ++-- .../docs/pages/integrations/feature-flags.mdx | 16 ++++++++-------- fern/products/docs/pages/navigation/overview.mdx | 4 ++-- 26 files changed, 74 insertions(+), 74 deletions(-) diff --git a/fern/products/docs/pages/api-references/api-explorer.mdx b/fern/products/docs/pages/api-references/api-explorer.mdx index 17882849..0307b5cf 100644 --- a/fern/products/docs/pages/api-references/api-explorer.mdx +++ b/fern/products/docs/pages/api-references/api-explorer.mdx @@ -24,8 +24,8 @@ Allow users to test their calls in a sandbox environment or select the environme
-### WebSocket Playground +### WebSocket playground For APIs that support WebSocket connections, the API Explorer includes a **WebSocket**-specific Playground. The WebSocket Playground also allows users to establish a connection with the API, and send/receive messages in real-time. -
\ No newline at end of file +
diff --git a/fern/products/docs/pages/api-references/autopopulate-api-key.mdx b/fern/products/docs/pages/api-references/autopopulate-api-key.mdx index 59b66624..7faaa76a 100644 --- a/fern/products/docs/pages/api-references/autopopulate-api-key.mdx +++ b/fern/products/docs/pages/api-references/autopopulate-api-key.mdx @@ -91,7 +91,7 @@ The JWT should have a structure similar to: #### Setting up auto-populated API keys -- [ ] Reach out to Fern to get your secret key +- [ ] Reach out to Fern to get your secret key - [ ] Send Fern the URL of your authentication page. This is where users will be redirected to after clicking the "Login" button in the API Explorer. - [ ] Add logic to your service to set the `fern_token` cookie when a user logs in diff --git a/fern/products/docs/pages/api-references/generate-openrpc-ref.mdx b/fern/products/docs/pages/api-references/generate-openrpc-ref.mdx index 037d7f3b..bbb35980 100644 --- a/fern/products/docs/pages/api-references/generate-openrpc-ref.mdx +++ b/fern/products/docs/pages/api-references/generate-openrpc-ref.mdx @@ -9,7 +9,7 @@ Fern enables you to generate professional, interactive API reference documentati Alchemy's OpenRPC API Reference Example -## How to Add an OpenRPC Endpoint +## How to add an OpenRPC endpoint 1. Add your OpenRPC specification file (e.g., `openrpc.yaml`) to your `/fern` directory. 2. Configure your `generators.yml` to point to your OpenRPC spec: @@ -22,13 +22,13 @@ Fern enables you to generate professional, interactive API reference documentati ``` -### Configuration Properties +### Configuration properties Path to your OpenRPC specification file. You can include multiple OpenRPC specs if your project exposes more than one JSON-RPC API. -## Common Use Cases +## Common use cases JSON-RPC APIs are widely used for: - **Blockchain & Crypto**: Node RPC endpoints, wallet APIs @@ -36,4 +36,4 @@ JSON-RPC APIs are widely used for: - **Developer Tools**: Language servers, debuggers, automation - **Distributed Systems**: Remote procedure calls between services -Leverage Fern and OpenRPC to deliver world-class developer experiences for your JSON-RPC APIs. \ No newline at end of file +Leverage Fern and OpenRPC to deliver world-class developer experiences for your JSON-RPC APIs. diff --git a/fern/products/docs/pages/api-references/http-snippets.mdx b/fern/products/docs/pages/api-references/http-snippets.mdx index 35a8a644..b9ed3031 100644 --- a/fern/products/docs/pages/api-references/http-snippets.mdx +++ b/fern/products/docs/pages/api-references/http-snippets.mdx @@ -31,15 +31,15 @@ settings: ``` -## How It Works +## How it works -### Request Examples +### Request examples To generate HTTP snippets, add request examples to your API definition: - For Fern Definition: Follow the [examples documentation](/learn/api-definition/fern/examples) - For OpenAPI: Follow the [request/response examples documentation](/learn/api-definition/openapi/extensions/others#request--response-examples) -### Set Default Snippet Language +### Set default snippet language HTTP snippets support several languages. Our development work is driven by customer requests, so please request support for languages not listed here by [opening an issue](https://github.com/fern-api/fern/issues/new/choose). @@ -66,7 +66,7 @@ navigation: ``` -### Generated Features +### Generated features HTTP snippets automatically include: - Authentication headers with placeholders (e.g., ``) @@ -75,7 +75,7 @@ HTTP snippets automatically include: - Error handling patterns - SSL/TLS configuration where applicable -### Display Behavior +### Display behavior - If your API has SDK snippets, those will be shown by default - If no SDK snippets exist, HTTP snippets will display automatically diff --git a/fern/products/docs/pages/api-references/sdk-snippets.mdx b/fern/products/docs/pages/api-references/sdk-snippets.mdx index 0d984502..245708f0 100644 --- a/fern/products/docs/pages/api-references/sdk-snippets.mdx +++ b/fern/products/docs/pages/api-references/sdk-snippets.mdx @@ -15,7 +15,7 @@ description: Enable SDK code examples in TypeScript, Python, Go, and more from t ![SDK code snippet selector](https://fern-image-hosting.s3.amazonaws.com/sdk-code-snippets.png) -## Configuring SDK Snippets +## Configuring SDK snippets To configure SDK snippets, you'll need to name your SDKs in `generators.yml` and then reference that name in `docs.yml`. diff --git a/fern/products/docs/pages/api-references/server-urls.mdx b/fern/products/docs/pages/api-references/server-urls.mdx index e7387e4e..8f315d5f 100644 --- a/fern/products/docs/pages/api-references/server-urls.mdx +++ b/fern/products/docs/pages/api-references/server-urls.mdx @@ -13,7 +13,7 @@ You can configure multiple server URLs in your API definition using either Fern - [Configure servers in OpenAPI](/learn/api-definition/openapi/extensions/others#server-names) - [Configure environments in Fern Definition](/learn/api-definition/fern/api-yml/environments) -## User Interface +## User interface When multiple servers are configured, users will see a dropdown menu in the API Reference that allows them to switch between environments: @@ -45,7 +45,7 @@ Here's an example of the [Flagright docs site](https://docs.flagright.com/framl- -## Environment Persistence +## Environment persistence When you select an environment, it's reflected across the entire API Reference - both in the displayed URLs and in the [API Explorer](/learn/docs/api-references/api-explorer). This selection persists as you navigate between different pages. diff --git a/fern/products/docs/pages/changelog/2024-01-24.mdx b/fern/products/docs/pages/changelog/2024-01-24.mdx index 99121ed2..19fdb61d 100644 --- a/fern/products/docs/pages/changelog/2024-01-24.mdx +++ b/fern/products/docs/pages/changelog/2024-01-24.mdx @@ -1,10 +1,10 @@ -## API Playground Launch +## API playground launch Enable interactive API testing directly in the documentation. - Added full API request testing capability - Improved error handling and status code display - Added support for recursive property rendering -## Enhanced Dark Mode +## Enhanced dark mode Multiple improvements to dark mode readability for syntax highlighting, dropdowns, and search results. ```css @@ -16,16 +16,16 @@ Multiple improvements to dark mode readability for syntax highlighting, dropdown } ``` -## Mobile-Friendly Navigation +## Mobile-friendly navigation Comprehensive updates to mobile navigation experience with collapsible and scrolling. -## Search Enhancements +## Search enhancements Multiple improvements to the search experience. - Default and configurable keyboard shortcuts (`Cmd+A`, `/`) for search - Improved search box sizing - Added auto-focus functionality -## Performance Optimization +## Performance optimization Several performance improvements across the platform. - Moved FontAwesome to CDN - Improved search dialog loading diff --git a/fern/products/docs/pages/changelog/2024-02-22.mdx b/fern/products/docs/pages/changelog/2024-02-22.mdx index bba034c9..4a9e8cce 100644 --- a/fern/products/docs/pages/changelog/2024-02-22.mdx +++ b/fern/products/docs/pages/changelog/2024-02-22.mdx @@ -1,13 +1,13 @@ -## WebSocket Support in API Playground +## WebSocket support in API playground Added real-time WebSocket testing capabilities to the API playground, enabling developers to test streaming and real-time endpoints directly in the documentation. WebSocket connections can now be established, tested, and debugged without leaving the docs. -## Enhanced Code Highlighting +## Enhanced code highlighting Implemented a new code highlighting system using Shiki for improved syntax highlighting accuracy and performance. The system now supports more languages and provides better dark mode compatibility. -## Feedback System +## Feedback system Introduced a new feedback collection system using Radix UI components for improved accessibility. Users can now provide structured feedback about documentation quality and usefulness directly within the interface. -## Layout Configuration System +## Layout configuration system Implemented a flexible layout configuration system that allows for custom header, footer, and sidebar arrangements. Documentation can now be customized to match your brand and preferences. ```yaml @@ -17,7 +17,7 @@ layout: searchbar-placement: header ``` -## Custom Styling Support +## Custom styling support Added support for custom CSS and scripts, enabling deep customization of documentation appearance and behavior. Organizations can now apply their branding consistently across their documentation. ```yaml docs.yml @@ -29,4 +29,4 @@ Added support for custom CSS and scripts, enabling deep customization of documen .custom-class { background-color: #f0f0f0; } -``` \ No newline at end of file +``` diff --git a/fern/products/docs/pages/changelog/2024-03-24.mdx b/fern/products/docs/pages/changelog/2024-03-24.mdx index 72e58ed4..d004aecd 100644 --- a/fern/products/docs/pages/changelog/2024-03-24.mdx +++ b/fern/products/docs/pages/changelog/2024-03-24.mdx @@ -1,10 +1,10 @@ # March 2024 -## Virtualized Syntax Highlighting +## Virtualized syntax highlighting Implemented performance-optimized code rendering that handles large code blocks efficiently without impacting page performance. Long code samples now load instantly and scroll smoothly. -## Mobile Search Experience +## Mobile search experience Redesigned the mobile search interface with a sticky search bar and improved results display. Users can now easily search documentation on mobile devices with a native-feeling interface. -## Scrollbar Refinement +## Scrollbar refinement Enhanced scrollbar design and behavior across all documentation sections for a more polished look and feel. Scrollbars now adapt to both light and dark themes while maintaining usability. diff --git a/fern/products/docs/pages/changelog/2024-04-20.mdx b/fern/products/docs/pages/changelog/2024-04-20.mdx index 4babfbd2..f0cf8e31 100644 --- a/fern/products/docs/pages/changelog/2024-04-20.mdx +++ b/fern/products/docs/pages/changelog/2024-04-20.mdx @@ -1,11 +1,11 @@ -## Sidebar Navigation Enhancement +## Sidebar navigation enhancement Improved sidebar padding and visual hierarchy with refined spacing and typography. The documentation navigation now provides clearer visual structure and better readability. -## Base Path Configuration +## Base path configuration Added flexible base path configuration for documentation routing. Organizations can now host documentation under custom paths while maintaining proper navigation. ```yaml docs.yml instances: - url: your-site.docs.buildwithfern.com custom-domain: your-site.com/docs -``` \ No newline at end of file +``` diff --git a/fern/products/docs/pages/changelog/2024-05-22.mdx b/fern/products/docs/pages/changelog/2024-05-22.mdx index cc965521..92b0ee46 100644 --- a/fern/products/docs/pages/changelog/2024-05-22.mdx +++ b/fern/products/docs/pages/changelog/2024-05-22.mdx @@ -1,4 +1,4 @@ -## Advanced Redirects +## Advanced redirects Implemented a powerful redirects system supporting pattern matching and parameter preservation. Teams can now manage documentation URL structure while maintaining backwards compatibility. ```yaml @@ -10,5 +10,5 @@ redirects: destination: /tutorials/:name ``` -## API Authorization Handling +## API authorization handling Enhanced API authorization handling in the documentation platform. Developers can now test authenticated endpoints more easily with improved token management. diff --git a/fern/products/docs/pages/changelog/2024-06-25.mdx b/fern/products/docs/pages/changelog/2024-06-25.mdx index be66135d..06b0b75c 100644 --- a/fern/products/docs/pages/changelog/2024-06-25.mdx +++ b/fern/products/docs/pages/changelog/2024-06-25.mdx @@ -1,9 +1,9 @@ # June 2024 -## RSS Feed Integration +## RSS feed integration Added support for RSS feeds to keep users updated on documentation changes. Teams can now offer automated notifications for their documentation. -## JSON-LD Enhancement +## JSON-LD enhancement Implemented structured data support through JSON-LD for improved SEO. Documentation pages now provide richer information to search engines and social platforms. ```json @@ -16,7 +16,7 @@ Implemented structured data support through JSON-LD for improved SEO. Documentat } ``` -## Image Zoom Controls +## Image zoom controls Added configurable image zoom functionality with custom triggers and behaviors. Users can now better examine diagrams and technical illustrations in documentation. ```mdx page.mdx @@ -25,7 +25,7 @@ no-image-zoom: true --- ``` -## Syntax Extension Support +## Syntax extension support Added support for additional syntax highlighting languages including BAML and Jinja. Documentation can now properly display a wider range of code examples. ```html @@ -50,4 +50,4 @@ Added support for additional syntax highlighting languages including BAML and Ji

No products are available at the moment.

{% endif %} -``` \ No newline at end of file +``` diff --git a/fern/products/docs/pages/changelog/2024-07-30.mdx b/fern/products/docs/pages/changelog/2024-07-30.mdx index 6c4f8b7b..0816fca3 100644 --- a/fern/products/docs/pages/changelog/2024-07-30.mdx +++ b/fern/products/docs/pages/changelog/2024-07-30.mdx @@ -1,6 +1,6 @@ # July 2024 -## Meta Image System +## Meta image system Implemented comprehensive meta image support for better social sharing. Documentation pages now display properly when shared on social media platforms. ```yaml diff --git a/fern/products/docs/pages/changelog/2024-08-20.mdx b/fern/products/docs/pages/changelog/2024-08-20.mdx index 1651f16e..227cd8bb 100644 --- a/fern/products/docs/pages/changelog/2024-08-20.mdx +++ b/fern/products/docs/pages/changelog/2024-08-20.mdx @@ -1,13 +1,13 @@ # August 2024 -## Anchor Link System +## Anchor link system Redesigned anchor link handling for improved navigation within documentation pages. Links now account for fixed headers and maintain proper scroll position when opened. -## WCAG Contrast Improvements +## WCAG contrast improvements Enhanced color contrast throughout the documentation platform for better accessibility. All text and interactive elements now meet WCAG AA standards by default and warnings are shown for any elements that do not meet WCAG AA standards. -## API Page Center Updates +## API page center updates Improved center element positioning and updates for API documentation pages. Content now flows more naturally and maintains position during navigation. -## Streaming Toggle Enhancement +## Streaming toggle enhancement Improved visibility and behavior of streaming response toggles in API playground. Users can now better control and monitor streaming responses. diff --git a/fern/products/docs/pages/changelog/2024-09-24.mdx b/fern/products/docs/pages/changelog/2024-09-24.mdx index 2de968ce..5fb9c38b 100644 --- a/fern/products/docs/pages/changelog/2024-09-24.mdx +++ b/fern/products/docs/pages/changelog/2024-09-24.mdx @@ -1,6 +1,6 @@ # September 2024 -## Environment Testing Interface +## Environment testing interface Created an editable playground environment system for testing API endpoints. Users can now switch between different API environments seamlessly within the documentation. ```yaml openapi.yml diff --git a/fern/products/docs/pages/changelog/2024-10-31.mdx b/fern/products/docs/pages/changelog/2024-10-31.mdx index ad2712cc..81abee5c 100644 --- a/fern/products/docs/pages/changelog/2024-10-31.mdx +++ b/fern/products/docs/pages/changelog/2024-10-31.mdx @@ -1,4 +1,4 @@ -## JWT API Key Integration +## JWT API key integration Implemented automatic API key extraction from JWT tokens in the documentation playground. Users can now test authenticated endpoints more easily with automatic credential handling. -## Query Parameter Enhancement -Improved handling of query parameters in documentation middleware. Complex query parameters are now properly handled and displayed in the documentation. \ No newline at end of file +## Query parameter enhancement +Improved handling of query parameters in documentation middleware. Complex query parameters are now properly handled and displayed in the documentation. diff --git a/fern/products/docs/pages/changelog/2024-11-27.mdx b/fern/products/docs/pages/changelog/2024-11-27.mdx index 256b4720..5c71611d 100644 --- a/fern/products/docs/pages/changelog/2024-11-27.mdx +++ b/fern/products/docs/pages/changelog/2024-11-27.mdx @@ -1,4 +1,4 @@ -## Auto-Populate Credentials in API Explorer +## Auto-populate credentials in API Explorer Save developers the hassle of finding and copying their API key. When authenticated, their API credentials will be automatically filled into the API Playground. This way, they can make their first API call even faster. @@ -7,7 +7,7 @@ Save developers the hassle of finding and copying their API key. When authentica Check it out live in [Webflow's API Explorer](https://developers.webflow.com/data/reference/sites/list?playground=/data/reference/sites/list). -## Card Component System +## Card component system Enhanced documentation card components for better visual organization. Information can now be presented in a more structured and appealing way. ```typescript diff --git a/fern/products/docs/pages/changelog/2024-12-30.mdx b/fern/products/docs/pages/changelog/2024-12-30.mdx index f75c355b..1e85880a 100644 --- a/fern/products/docs/pages/changelog/2024-12-30.mdx +++ b/fern/products/docs/pages/changelog/2024-12-30.mdx @@ -1,9 +1,9 @@ -## Audio Streaming in API Explorer +## Audio streaming in API Explorer Added support for streaming audio directly within the API Explorer. This feature enables testing audio endpoints without leaving the documentation. Check it out live in ElevenLabs' [API Explorer](https://elevenlabs.io/docs/api-reference/text-to-speech/convert?playground=/docs/api-reference/text-to-speech/convert-as-stream) to let users test text-to-speech endpoints and hear the results instantly. -## Form Data Optimization +## Form data optimization Enhanced handling of URL parameters and form data in edge functions. Documentation playground now handles complex data structures more efficiently. ```typescript @@ -14,4 +14,4 @@ const formConfig = { sanitize: true, maxDepth: 5 } -``` \ No newline at end of file +``` diff --git a/fern/products/docs/pages/changelog/2025-01-21.mdx b/fern/products/docs/pages/changelog/2025-01-21.mdx index 9970a1a6..f575355a 100644 --- a/fern/products/docs/pages/changelog/2025-01-21.mdx +++ b/fern/products/docs/pages/changelog/2025-01-21.mdx @@ -1,4 +1,4 @@ -## Improvements to the Accordion Component +## Improvements to the accordion component The accordion component has been upgraded so that you can now use your in-browser `cmd+f` search to look for text that is otherwise hidden. @@ -22,4 +22,4 @@ To embed an asset, you can use the `embed` tag. ``` -Read more [here](https://buildwithfern.com/learn/docs/content/write-markdown#embedding-local-assets) \ No newline at end of file +Read more [here](https://buildwithfern.com/learn/docs/content/write-markdown#embedding-local-assets) diff --git a/fern/products/docs/pages/changelog/2025-05-22.mdx b/fern/products/docs/pages/changelog/2025-05-22.mdx index 2199aa61..b9ffdbdb 100644 --- a/fern/products/docs/pages/changelog/2025-05-22.mdx +++ b/fern/products/docs/pages/changelog/2025-05-22.mdx @@ -1,7 +1,7 @@ -## Improvements to 404 Pages +## Improvements to 404 pages We now have themed 404 pages for your docs, using your theme colors, fonts, and buttons. We also maintain the best-effort navigation state on this page using the 404 page URL, so that users can easily navigate back to your docs. ![404 Page](./404-page.png) - \ No newline at end of file + diff --git a/fern/products/docs/pages/changelog/2025-06-05.mdx b/fern/products/docs/pages/changelog/2025-06-05.mdx index 09eba157..d68ff600 100644 --- a/fern/products/docs/pages/changelog/2025-06-05.mdx +++ b/fern/products/docs/pages/changelog/2025-06-05.mdx @@ -1,4 +1,4 @@ -## Introducing The Product Switcher +## Introducing the product switcher Organize your docs by product so developers can find what they need quickly. Perfect for companies with multiple APIs, each with their own references, guides, versions, and changelogs. diff --git a/fern/products/docs/pages/changelog/2025-10-17.mdx b/fern/products/docs/pages/changelog/2025-10-17.mdx index ce00ceb2..9f199d45 100644 --- a/fern/products/docs/pages/changelog/2025-10-17.mdx +++ b/fern/products/docs/pages/changelog/2025-10-17.mdx @@ -1,4 +1,4 @@ -## HTTP Snippets now enabled by default +## HTTP snippets now enabled by default HTTP snippets are now enabled by default for all documentation sites, making it easier for developers to see cURL, Python, Ruby, and other HTTP client examples directly in your API reference. Previously, this feature required internal configuration to activate. @@ -18,7 +18,7 @@ settings: Visit the [HTTP snippets documentation](/docs/api-references/http-snippets) to learn more. -## Introducing Runnable Endpoint +## Introducing runnable endpoint Test API endpoints directly from your documentation with our new interactive component. Runnable Endpoint allows your users to send real HTTP requests to your API without leaving your docs, making it easier for developers to explore and understand your API. diff --git a/fern/products/docs/pages/component-library/default-components/embed.mdx b/fern/products/docs/pages/component-library/default-components/embed.mdx index c0d97db8..ae17a168 100644 --- a/fern/products/docs/pages/component-library/default-components/embed.mdx +++ b/fern/products/docs/pages/component-library/default-components/embed.mdx @@ -28,7 +28,7 @@ Fern also implements a custom component for embedding downloadable assets: ## Examples -### Video File +### Video file @@ -57,7 +57,7 @@ Fern also implements a custom component for embedding downloadable assets: -### PDF Document +### PDF document diff --git a/fern/products/docs/pages/customization/search.mdx b/fern/products/docs/pages/customization/search.mdx index 7f4ef3cf..05ea6503 100644 --- a/fern/products/docs/pages/customization/search.mdx +++ b/fern/products/docs/pages/customization/search.mdx @@ -30,7 +30,7 @@ If you are using the AI Search feature, the search box also functions as your si If you need to integrate Fern's documentation search into your own application or dashboard, you can request Algolia credentials directly from the Fern team. These credentials will allow you to query the same search index that powers your documentation site's search functionality. -### Making Search Requests +### Making search requests Once you have your credentials, you can make requests to Algolia's API to search your documentation. @@ -42,4 +42,4 @@ Contact the Fern team to get your specific application ID and index name. Creden ## Using an alternative search -You can override Fern's search with your own solution using [custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript) and your Algolia credentials. \ No newline at end of file +You can override Fern's search with your own solution using [custom JavaScript](/learn/docs/building-and-customizing-your-docs/custom-css-global-js#custom-javascript) and your Algolia credentials. diff --git a/fern/products/docs/pages/integrations/feature-flags.mdx b/fern/products/docs/pages/integrations/feature-flags.mdx index 5559e785..ffcd5438 100644 --- a/fern/products/docs/pages/integrations/feature-flags.mdx +++ b/fern/products/docs/pages/integrations/feature-flags.mdx @@ -8,7 +8,7 @@ description: Learn how to use Feature Flags in your Fern documentation Fern supports conditional rendering of documentation content using feature flags, powered by [LaunchDarkly](https://app.launchdarkly.com/signup) integration. Control visibility of documentation sections based on feature flag states for different release stages or user segments. -## Use Cases +## Use cases Feature flags in documentation are particularly useful for: @@ -44,7 +44,7 @@ navigation: To read more about `fallbackValue` and `match`, see the [LaunchDarkly documentation](https://launchdarkly.com/docs/guides/flags/testing-code#fallback-values). -## Using Feature Flags in MDX +## Using feature flags in MDX Use the `` component to conditionally render content: @@ -63,7 +63,7 @@ Use the `` component to conditionally render content: ``` -### Component Properties +### Component properties Name of the feature flag to check against @@ -77,7 +77,7 @@ Use the `` component to conditionally render content: Default value if the feature flag is not defined -## Example: Complete Configuration +## Example: Complete configuration ```yaml # docs.yml @@ -101,7 +101,7 @@ navigation: fallbackValue: standard ``` -## Real-time Evaluation +## Real-time evaluation Feature flags are client-side only. The information is only visually hidden when the feature flag is evaluated as false. @@ -109,10 +109,10 @@ If you toggle a feature flag on in the LaunchDarkly dashboard, the content will Conversely, if you toggle a feature flag off in the LaunchDarkly dashboard, the content will be hidden immediately. -## Server-side Evaluation +## Server-side evaluation Feature flags are client-side only. Want to request server-side evaluation? [Let us know](https://github.com/fern-api/fern/issues) by filing a feature request. -## Additional Feature Flag Providers +## Additional feature flag providers -Want to request a new feature flag provider? [Let us know](https://github.com/fern-api/fern/issues) by filing a feature request. \ No newline at end of file +Want to request a new feature flag provider? [Let us know](https://github.com/fern-api/fern/issues) by filing a feature request. diff --git a/fern/products/docs/pages/navigation/overview.mdx b/fern/products/docs/pages/navigation/overview.mdx index 25a7ffd0..d16f2347 100644 --- a/fern/products/docs/pages/navigation/overview.mdx +++ b/fern/products/docs/pages/navigation/overview.mdx @@ -7,7 +7,7 @@ description: Set up the navigation for your documentation site built with Fern D Every Fern Docs website has a special configuration file called `docs.yml`. Use this file to configure the navigation for your documentation site. -### Example Configuration +### Example configuration Here's a complete example of a `docs.yml` file: @@ -299,4 +299,4 @@ products: ``` -For more information about setting up this up, check out our [documentation on product switching](/learn/docs/configuration/products). \ No newline at end of file +For more information about setting up this up, check out our [documentation on product switching](/learn/docs/configuration/products). From bd186722a651cfa22e7e097af28ca97e3d3e81e0 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 17:28:30 +0000 Subject: [PATCH 03/14] Fix additional headings in integrations files - Fixed feature-flags.mdx: Use cases, Component properties, etc. - Fixed google.mdx: Integration steps Co-Authored-By: Devin Logan --- fern/products/docs/pages/integrations/analytics/google.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fern/products/docs/pages/integrations/analytics/google.mdx b/fern/products/docs/pages/integrations/analytics/google.mdx index 78401e54..da476638 100644 --- a/fern/products/docs/pages/integrations/analytics/google.mdx +++ b/fern/products/docs/pages/integrations/analytics/google.mdx @@ -11,7 +11,7 @@ Fern supports integrating with both [Google Analytics 4](https://developers.goog Before you begin, ensure you have a Google Analytics 4 property ID. This ID is typically in the format `G-XXXXXXXXXX`. -### Integration Steps +### Integration steps 1. Open your `docs.yml` file. 2. Add your Google Analytics 4 property ID under the `measurement-id` key. @@ -44,7 +44,7 @@ analytics: To use Google Tag Manager, obtain a container ID from your Google Tag Manager account. This ID follows the format `GTM-XXXXXX`. -### Integration Steps +### Integration steps 1. Open your `docs.yml` file. 2. Add your Google Tag Manager container ID under the container-id key. From 226a9cf389d3d4398b31a82cd7c89e3018b0794d Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 17:30:21 +0000 Subject: [PATCH 04/14] Fix Vale error: Remove hyphen from Auto-populate Co-Authored-By: Devin Logan --- fern/products/docs/pages/changelog/2024-11-27.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/changelog/2024-11-27.mdx b/fern/products/docs/pages/changelog/2024-11-27.mdx index 5c71611d..13f423f3 100644 --- a/fern/products/docs/pages/changelog/2024-11-27.mdx +++ b/fern/products/docs/pages/changelog/2024-11-27.mdx @@ -1,4 +1,4 @@ -## Auto-populate credentials in API Explorer +## Autopopulate credentials in API Explorer Save developers the hassle of finding and copying their API key. When authenticated, their API credentials will be automatically filled into the API Playground. This way, they can make their first API call even faster. From 53c3b9b25bc669d998e465cf86d6059dd7a5d9bb Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 17:31:48 +0000 Subject: [PATCH 05/14] Fix additional headings in developer-tools files - Fixed cursor.mdx: Callouts, Cards & card groups Co-Authored-By: Devin Logan --- fern/products/docs/pages/developer-tools/cursor.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fern/products/docs/pages/developer-tools/cursor.mdx b/fern/products/docs/pages/developer-tools/cursor.mdx index 8492d4be..25517e11 100644 --- a/fern/products/docs/pages/developer-tools/cursor.mdx +++ b/fern/products/docs/pages/developer-tools/cursor.mdx @@ -103,7 +103,7 @@ Use the following components whenever possible to enhance readability and struct ```` -### Callouts (Tips, Notes, Warnings, etc.) +### Callouts (tips, notes, warnings, etc.) ``` @@ -117,7 +117,7 @@ This Callout uses a title and a custom icon. This brings us a checked status ``` -### Cards & Card Groups +### Cards & card groups ``` Date: Thu, 23 Oct 2025 17:38:23 +0000 Subject: [PATCH 06/14] Revert changes to changelog and component-library files Per user request, removing changes to: - All changelog files (2024-2025) - Component library embed.mdx file These will be handled in separate PRs Co-Authored-By: Devin Logan --- fern/products/docs/pages/changelog/2024-01-24.mdx | 10 +++++----- fern/products/docs/pages/changelog/2024-02-22.mdx | 12 ++++++------ fern/products/docs/pages/changelog/2024-03-24.mdx | 6 +++--- fern/products/docs/pages/changelog/2024-04-20.mdx | 6 +++--- fern/products/docs/pages/changelog/2024-05-22.mdx | 4 ++-- fern/products/docs/pages/changelog/2024-06-25.mdx | 10 +++++----- fern/products/docs/pages/changelog/2024-07-30.mdx | 2 +- fern/products/docs/pages/changelog/2024-08-20.mdx | 8 ++++---- fern/products/docs/pages/changelog/2024-09-24.mdx | 2 +- fern/products/docs/pages/changelog/2024-10-31.mdx | 6 +++--- fern/products/docs/pages/changelog/2024-11-27.mdx | 4 ++-- fern/products/docs/pages/changelog/2024-12-30.mdx | 6 +++--- fern/products/docs/pages/changelog/2025-01-21.mdx | 4 ++-- fern/products/docs/pages/changelog/2025-05-22.mdx | 4 ++-- fern/products/docs/pages/changelog/2025-06-05.mdx | 2 +- fern/products/docs/pages/changelog/2025-10-17.mdx | 4 ++-- .../component-library/default-components/embed.mdx | 4 ++-- 17 files changed, 47 insertions(+), 47 deletions(-) diff --git a/fern/products/docs/pages/changelog/2024-01-24.mdx b/fern/products/docs/pages/changelog/2024-01-24.mdx index 19fdb61d..99121ed2 100644 --- a/fern/products/docs/pages/changelog/2024-01-24.mdx +++ b/fern/products/docs/pages/changelog/2024-01-24.mdx @@ -1,10 +1,10 @@ -## API playground launch +## API Playground Launch Enable interactive API testing directly in the documentation. - Added full API request testing capability - Improved error handling and status code display - Added support for recursive property rendering -## Enhanced dark mode +## Enhanced Dark Mode Multiple improvements to dark mode readability for syntax highlighting, dropdowns, and search results. ```css @@ -16,16 +16,16 @@ Multiple improvements to dark mode readability for syntax highlighting, dropdown } ``` -## Mobile-friendly navigation +## Mobile-Friendly Navigation Comprehensive updates to mobile navigation experience with collapsible and scrolling. -## Search enhancements +## Search Enhancements Multiple improvements to the search experience. - Default and configurable keyboard shortcuts (`Cmd+A`, `/`) for search - Improved search box sizing - Added auto-focus functionality -## Performance optimization +## Performance Optimization Several performance improvements across the platform. - Moved FontAwesome to CDN - Improved search dialog loading diff --git a/fern/products/docs/pages/changelog/2024-02-22.mdx b/fern/products/docs/pages/changelog/2024-02-22.mdx index 4a9e8cce..bba034c9 100644 --- a/fern/products/docs/pages/changelog/2024-02-22.mdx +++ b/fern/products/docs/pages/changelog/2024-02-22.mdx @@ -1,13 +1,13 @@ -## WebSocket support in API playground +## WebSocket Support in API Playground Added real-time WebSocket testing capabilities to the API playground, enabling developers to test streaming and real-time endpoints directly in the documentation. WebSocket connections can now be established, tested, and debugged without leaving the docs. -## Enhanced code highlighting +## Enhanced Code Highlighting Implemented a new code highlighting system using Shiki for improved syntax highlighting accuracy and performance. The system now supports more languages and provides better dark mode compatibility. -## Feedback system +## Feedback System Introduced a new feedback collection system using Radix UI components for improved accessibility. Users can now provide structured feedback about documentation quality and usefulness directly within the interface. -## Layout configuration system +## Layout Configuration System Implemented a flexible layout configuration system that allows for custom header, footer, and sidebar arrangements. Documentation can now be customized to match your brand and preferences. ```yaml @@ -17,7 +17,7 @@ layout: searchbar-placement: header ``` -## Custom styling support +## Custom Styling Support Added support for custom CSS and scripts, enabling deep customization of documentation appearance and behavior. Organizations can now apply their branding consistently across their documentation. ```yaml docs.yml @@ -29,4 +29,4 @@ Added support for custom CSS and scripts, enabling deep customization of documen .custom-class { background-color: #f0f0f0; } -``` +``` \ No newline at end of file diff --git a/fern/products/docs/pages/changelog/2024-03-24.mdx b/fern/products/docs/pages/changelog/2024-03-24.mdx index d004aecd..72e58ed4 100644 --- a/fern/products/docs/pages/changelog/2024-03-24.mdx +++ b/fern/products/docs/pages/changelog/2024-03-24.mdx @@ -1,10 +1,10 @@ # March 2024 -## Virtualized syntax highlighting +## Virtualized Syntax Highlighting Implemented performance-optimized code rendering that handles large code blocks efficiently without impacting page performance. Long code samples now load instantly and scroll smoothly. -## Mobile search experience +## Mobile Search Experience Redesigned the mobile search interface with a sticky search bar and improved results display. Users can now easily search documentation on mobile devices with a native-feeling interface. -## Scrollbar refinement +## Scrollbar Refinement Enhanced scrollbar design and behavior across all documentation sections for a more polished look and feel. Scrollbars now adapt to both light and dark themes while maintaining usability. diff --git a/fern/products/docs/pages/changelog/2024-04-20.mdx b/fern/products/docs/pages/changelog/2024-04-20.mdx index f0cf8e31..4babfbd2 100644 --- a/fern/products/docs/pages/changelog/2024-04-20.mdx +++ b/fern/products/docs/pages/changelog/2024-04-20.mdx @@ -1,11 +1,11 @@ -## Sidebar navigation enhancement +## Sidebar Navigation Enhancement Improved sidebar padding and visual hierarchy with refined spacing and typography. The documentation navigation now provides clearer visual structure and better readability. -## Base path configuration +## Base Path Configuration Added flexible base path configuration for documentation routing. Organizations can now host documentation under custom paths while maintaining proper navigation. ```yaml docs.yml instances: - url: your-site.docs.buildwithfern.com custom-domain: your-site.com/docs -``` +``` \ No newline at end of file diff --git a/fern/products/docs/pages/changelog/2024-05-22.mdx b/fern/products/docs/pages/changelog/2024-05-22.mdx index 92b0ee46..cc965521 100644 --- a/fern/products/docs/pages/changelog/2024-05-22.mdx +++ b/fern/products/docs/pages/changelog/2024-05-22.mdx @@ -1,4 +1,4 @@ -## Advanced redirects +## Advanced Redirects Implemented a powerful redirects system supporting pattern matching and parameter preservation. Teams can now manage documentation URL structure while maintaining backwards compatibility. ```yaml @@ -10,5 +10,5 @@ redirects: destination: /tutorials/:name ``` -## API authorization handling +## API Authorization Handling Enhanced API authorization handling in the documentation platform. Developers can now test authenticated endpoints more easily with improved token management. diff --git a/fern/products/docs/pages/changelog/2024-06-25.mdx b/fern/products/docs/pages/changelog/2024-06-25.mdx index 06b0b75c..be66135d 100644 --- a/fern/products/docs/pages/changelog/2024-06-25.mdx +++ b/fern/products/docs/pages/changelog/2024-06-25.mdx @@ -1,9 +1,9 @@ # June 2024 -## RSS feed integration +## RSS Feed Integration Added support for RSS feeds to keep users updated on documentation changes. Teams can now offer automated notifications for their documentation. -## JSON-LD enhancement +## JSON-LD Enhancement Implemented structured data support through JSON-LD for improved SEO. Documentation pages now provide richer information to search engines and social platforms. ```json @@ -16,7 +16,7 @@ Implemented structured data support through JSON-LD for improved SEO. Documentat } ``` -## Image zoom controls +## Image Zoom Controls Added configurable image zoom functionality with custom triggers and behaviors. Users can now better examine diagrams and technical illustrations in documentation. ```mdx page.mdx @@ -25,7 +25,7 @@ no-image-zoom: true --- ``` -## Syntax extension support +## Syntax Extension Support Added support for additional syntax highlighting languages including BAML and Jinja. Documentation can now properly display a wider range of code examples. ```html @@ -50,4 +50,4 @@ Added support for additional syntax highlighting languages including BAML and Ji

No products are available at the moment.

{% endif %} -``` +``` \ No newline at end of file diff --git a/fern/products/docs/pages/changelog/2024-07-30.mdx b/fern/products/docs/pages/changelog/2024-07-30.mdx index 0816fca3..6c4f8b7b 100644 --- a/fern/products/docs/pages/changelog/2024-07-30.mdx +++ b/fern/products/docs/pages/changelog/2024-07-30.mdx @@ -1,6 +1,6 @@ # July 2024 -## Meta image system +## Meta Image System Implemented comprehensive meta image support for better social sharing. Documentation pages now display properly when shared on social media platforms. ```yaml diff --git a/fern/products/docs/pages/changelog/2024-08-20.mdx b/fern/products/docs/pages/changelog/2024-08-20.mdx index 227cd8bb..1651f16e 100644 --- a/fern/products/docs/pages/changelog/2024-08-20.mdx +++ b/fern/products/docs/pages/changelog/2024-08-20.mdx @@ -1,13 +1,13 @@ # August 2024 -## Anchor link system +## Anchor Link System Redesigned anchor link handling for improved navigation within documentation pages. Links now account for fixed headers and maintain proper scroll position when opened. -## WCAG contrast improvements +## WCAG Contrast Improvements Enhanced color contrast throughout the documentation platform for better accessibility. All text and interactive elements now meet WCAG AA standards by default and warnings are shown for any elements that do not meet WCAG AA standards. -## API page center updates +## API Page Center Updates Improved center element positioning and updates for API documentation pages. Content now flows more naturally and maintains position during navigation. -## Streaming toggle enhancement +## Streaming Toggle Enhancement Improved visibility and behavior of streaming response toggles in API playground. Users can now better control and monitor streaming responses. diff --git a/fern/products/docs/pages/changelog/2024-09-24.mdx b/fern/products/docs/pages/changelog/2024-09-24.mdx index 5fb9c38b..2de968ce 100644 --- a/fern/products/docs/pages/changelog/2024-09-24.mdx +++ b/fern/products/docs/pages/changelog/2024-09-24.mdx @@ -1,6 +1,6 @@ # September 2024 -## Environment testing interface +## Environment Testing Interface Created an editable playground environment system for testing API endpoints. Users can now switch between different API environments seamlessly within the documentation. ```yaml openapi.yml diff --git a/fern/products/docs/pages/changelog/2024-10-31.mdx b/fern/products/docs/pages/changelog/2024-10-31.mdx index 81abee5c..ad2712cc 100644 --- a/fern/products/docs/pages/changelog/2024-10-31.mdx +++ b/fern/products/docs/pages/changelog/2024-10-31.mdx @@ -1,4 +1,4 @@ -## JWT API key integration +## JWT API Key Integration Implemented automatic API key extraction from JWT tokens in the documentation playground. Users can now test authenticated endpoints more easily with automatic credential handling. -## Query parameter enhancement -Improved handling of query parameters in documentation middleware. Complex query parameters are now properly handled and displayed in the documentation. +## Query Parameter Enhancement +Improved handling of query parameters in documentation middleware. Complex query parameters are now properly handled and displayed in the documentation. \ No newline at end of file diff --git a/fern/products/docs/pages/changelog/2024-11-27.mdx b/fern/products/docs/pages/changelog/2024-11-27.mdx index 13f423f3..256b4720 100644 --- a/fern/products/docs/pages/changelog/2024-11-27.mdx +++ b/fern/products/docs/pages/changelog/2024-11-27.mdx @@ -1,4 +1,4 @@ -## Autopopulate credentials in API Explorer +## Auto-Populate Credentials in API Explorer Save developers the hassle of finding and copying their API key. When authenticated, their API credentials will be automatically filled into the API Playground. This way, they can make their first API call even faster. @@ -7,7 +7,7 @@ Save developers the hassle of finding and copying their API key. When authentica Check it out live in [Webflow's API Explorer](https://developers.webflow.com/data/reference/sites/list?playground=/data/reference/sites/list). -## Card component system +## Card Component System Enhanced documentation card components for better visual organization. Information can now be presented in a more structured and appealing way. ```typescript diff --git a/fern/products/docs/pages/changelog/2024-12-30.mdx b/fern/products/docs/pages/changelog/2024-12-30.mdx index 1e85880a..f75c355b 100644 --- a/fern/products/docs/pages/changelog/2024-12-30.mdx +++ b/fern/products/docs/pages/changelog/2024-12-30.mdx @@ -1,9 +1,9 @@ -## Audio streaming in API Explorer +## Audio Streaming in API Explorer Added support for streaming audio directly within the API Explorer. This feature enables testing audio endpoints without leaving the documentation. Check it out live in ElevenLabs' [API Explorer](https://elevenlabs.io/docs/api-reference/text-to-speech/convert?playground=/docs/api-reference/text-to-speech/convert-as-stream) to let users test text-to-speech endpoints and hear the results instantly. -## Form data optimization +## Form Data Optimization Enhanced handling of URL parameters and form data in edge functions. Documentation playground now handles complex data structures more efficiently. ```typescript @@ -14,4 +14,4 @@ const formConfig = { sanitize: true, maxDepth: 5 } -``` +``` \ No newline at end of file diff --git a/fern/products/docs/pages/changelog/2025-01-21.mdx b/fern/products/docs/pages/changelog/2025-01-21.mdx index f575355a..9970a1a6 100644 --- a/fern/products/docs/pages/changelog/2025-01-21.mdx +++ b/fern/products/docs/pages/changelog/2025-01-21.mdx @@ -1,4 +1,4 @@ -## Improvements to the accordion component +## Improvements to the Accordion Component The accordion component has been upgraded so that you can now use your in-browser `cmd+f` search to look for text that is otherwise hidden. @@ -22,4 +22,4 @@ To embed an asset, you can use the `embed` tag. ``` -Read more [here](https://buildwithfern.com/learn/docs/content/write-markdown#embedding-local-assets) +Read more [here](https://buildwithfern.com/learn/docs/content/write-markdown#embedding-local-assets) \ No newline at end of file diff --git a/fern/products/docs/pages/changelog/2025-05-22.mdx b/fern/products/docs/pages/changelog/2025-05-22.mdx index b9ffdbdb..2199aa61 100644 --- a/fern/products/docs/pages/changelog/2025-05-22.mdx +++ b/fern/products/docs/pages/changelog/2025-05-22.mdx @@ -1,7 +1,7 @@ -## Improvements to 404 pages +## Improvements to 404 Pages We now have themed 404 pages for your docs, using your theme colors, fonts, and buttons. We also maintain the best-effort navigation state on this page using the 404 page URL, so that users can easily navigate back to your docs. ![404 Page](./404-page.png) - + \ No newline at end of file diff --git a/fern/products/docs/pages/changelog/2025-06-05.mdx b/fern/products/docs/pages/changelog/2025-06-05.mdx index d68ff600..09eba157 100644 --- a/fern/products/docs/pages/changelog/2025-06-05.mdx +++ b/fern/products/docs/pages/changelog/2025-06-05.mdx @@ -1,4 +1,4 @@ -## Introducing the product switcher +## Introducing The Product Switcher Organize your docs by product so developers can find what they need quickly. Perfect for companies with multiple APIs, each with their own references, guides, versions, and changelogs. diff --git a/fern/products/docs/pages/changelog/2025-10-17.mdx b/fern/products/docs/pages/changelog/2025-10-17.mdx index 9f199d45..ce00ceb2 100644 --- a/fern/products/docs/pages/changelog/2025-10-17.mdx +++ b/fern/products/docs/pages/changelog/2025-10-17.mdx @@ -1,4 +1,4 @@ -## HTTP snippets now enabled by default +## HTTP Snippets now enabled by default HTTP snippets are now enabled by default for all documentation sites, making it easier for developers to see cURL, Python, Ruby, and other HTTP client examples directly in your API reference. Previously, this feature required internal configuration to activate. @@ -18,7 +18,7 @@ settings: Visit the [HTTP snippets documentation](/docs/api-references/http-snippets) to learn more. -## Introducing runnable endpoint +## Introducing Runnable Endpoint Test API endpoints directly from your documentation with our new interactive component. Runnable Endpoint allows your users to send real HTTP requests to your API without leaving your docs, making it easier for developers to explore and understand your API. diff --git a/fern/products/docs/pages/component-library/default-components/embed.mdx b/fern/products/docs/pages/component-library/default-components/embed.mdx index ae17a168..c0d97db8 100644 --- a/fern/products/docs/pages/component-library/default-components/embed.mdx +++ b/fern/products/docs/pages/component-library/default-components/embed.mdx @@ -28,7 +28,7 @@ Fern also implements a custom component for embedding downloadable assets: ## Examples -### Video file +### Video File @@ -57,7 +57,7 @@ Fern also implements a custom component for embedding downloadable assets: -### PDF document +### PDF Document From 033432a0bd64c3cb3d2e69f71919f7f889d0ed14 Mon Sep 17 00:00:00 2001 From: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Thu, 23 Oct 2025 17:47:47 +0000 Subject: [PATCH 07/14] Revert all component-library file changes and navigation titles Per user request, reverting: - All 12 component-library MDX files (accordion-groups, card-groups, code-blocks, embed, endpoint snippets, icons, overview, runnable-endpoint, steps, visual-editor) - All component-library navigation titles in docs.yml Component-library changes will be handled in a separate PR Co-Authored-By: Devin Logan --- fern/products/docs/docs.yml | 14 +++++++------- .../default-components/accordion-groups.mdx | 6 +++--- .../default-components/card-groups.mdx | 2 +- .../default-components/code-blocks.mdx | 4 ++-- .../component-library/default-components/embed.mdx | 6 +++--- .../endpoint-request-snippet.mdx | 2 +- .../endpoint-response-snippet.mdx | 2 +- .../default-components/endpoint-schema-snippet.mdx | 2 +- .../component-library/default-components/icons.mdx | 4 ++-- .../default-components/overview.mdx | 2 +- .../default-components/runnable-endpoint.mdx | 2 +- .../component-library/default-components/steps.mdx | 4 ++-- .../writing-content/visual-editor.mdx | 2 +- 13 files changed, 26 insertions(+), 26 deletions(-) diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 9590d898..8595344d 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -38,7 +38,7 @@ navigation: - page: Accordions path: ./pages/component-library/default-components/accordions.mdx icon: fa-duotone fa-chevron-down - - page: Accordion groups + - page: Accordion Groups path: ./pages/component-library/default-components/accordion-groups.mdx icon: fa-duotone fa-chevrons-down - page: Aside @@ -56,28 +56,28 @@ navigation: - page: Cards path: ./pages/component-library/default-components/cards.mdx icon: fa-duotone fa-id-card - - page: Card groups + - page: Card Groups path: ./pages/component-library/default-components/card-groups.mdx icon: fa-duotone fa-grid-2 - - page: Code blocks + - page: Code Blocks path: ./pages/component-library/default-components/code-blocks.mdx icon: fa-duotone fa-code - page: Embed path: ./pages/component-library/default-components/embed.mdx icon: fa-duotone fa-window-restore - - page: Endpoint request snippet + - page: Endpoint Request Snippet path: ./pages/component-library/default-components/endpoint-request-snippet.mdx icon: fa-duotone fa-arrow-up slug: request-snippet - - page: Endpoint response snippet + - page: Endpoint Response Snippet path: ./pages/component-library/default-components/endpoint-response-snippet.mdx icon: fa-duotone fa-arrow-down slug: response-snippet - - page: Endpoint schema snippet + - page: Endpoint Schema Snippet path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx icon: fa-duotone fa-sitemap slug: schema-snippet - - page: Runnable endpoint + - page: Runnable Endpoint path: ./pages/component-library/default-components/runnable-endpoint.mdx icon: fa-duotone fa-play-circle - page: Frames diff --git a/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx b/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx index 4201eb10..b977489a 100644 --- a/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx +++ b/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx @@ -1,5 +1,5 @@ --- -title: 'Accordion groups' +title: 'Accordion Groups' description: 'Display expandable/collapsible options that reveal more information with improved search functionality' --- @@ -30,11 +30,11 @@ Accordion Groups allow you to organize content into collapsible sections, making -### Enhanced search functionality +### Enhanced Search Functionality The recent update to our Accordion component improves content discoverability by allowing users to search through all content, including collapsed sections, using the browser's search function (Cmd+F / Ctrl+F). -### Usage examples +### Usage Examples Here are some examples of how to use the Accordion Group component: diff --git a/fern/products/docs/pages/component-library/default-components/card-groups.mdx b/fern/products/docs/pages/component-library/default-components/card-groups.mdx index 3093aee1..cb30305d 100644 --- a/fern/products/docs/pages/component-library/default-components/card-groups.mdx +++ b/fern/products/docs/pages/component-library/default-components/card-groups.mdx @@ -1,5 +1,5 @@ --- -title: 'Card groups' +title: 'Card Groups' description: 'Show cards side by side in a grid format' --- diff --git a/fern/products/docs/pages/component-library/default-components/code-blocks.mdx b/fern/products/docs/pages/component-library/default-components/code-blocks.mdx index d4e8f6a2..76a34af2 100644 --- a/fern/products/docs/pages/component-library/default-components/code-blocks.mdx +++ b/fern/products/docs/pages/component-library/default-components/code-blocks.mdx @@ -1,5 +1,5 @@ --- -title: 'Code blocks' +title: 'Code Blocks' description: 'Learn how to enhance your documentation with customizable code blocks featuring syntax highlighting, line highlighting, focusing, and more.' --- @@ -343,7 +343,7 @@ and a maximum height. -## Code blocks with tabs +## Code Blocks with Tabs The `CodeBlocks` component allows you to display multiple code blocks in a tabbed interface. diff --git a/fern/products/docs/pages/component-library/default-components/embed.mdx b/fern/products/docs/pages/component-library/default-components/embed.mdx index c0d97db8..fa7aaa40 100644 --- a/fern/products/docs/pages/component-library/default-components/embed.mdx +++ b/fern/products/docs/pages/component-library/default-components/embed.mdx @@ -1,5 +1,5 @@ --- -title: "Embedded assets and files" +title: "Embedded Assets and Files" description: "Embed local assets like PDFs, videos, and more in your documentation" --- @@ -65,7 +65,7 @@ Fern also implements a custom component for embedding downloadable assets: ``` -## Common MIME types +## Common MIME Types | File Type | MIME Type | | ---------- | ----------------- | @@ -81,7 +81,7 @@ Fern also implements a custom component for embedding downloadable assets: video files, consider using MP4 format for maximum compatibility. -## Downloadable assets +## Downloadable Assets Enable users to download assets from within your documentation, instead of linking to them, by using the `` component. diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx index 6b09b974..8fa68adb 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx @@ -1,5 +1,5 @@ --- -title: 'Endpoint request snippet' +title: 'Endpoint Request Snippet' description: 'Reference an endpoint request from your API Reference' --- diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx index 625ec78d..197f78ba 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx @@ -1,5 +1,5 @@ --- -title: 'Endpoint response snippet' +title: 'Endpoint Response Snippet' description: 'Reference an endpoint response from your API Reference' --- diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx index 042ab3e7..f5023a5e 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx @@ -1,5 +1,5 @@ --- -title: 'Endpoint schema snippet' +title: 'Endpoint Schema Snippet' description: 'Reference an endpoint schema from your API Reference' --- diff --git a/fern/products/docs/pages/component-library/default-components/icons.mdx b/fern/products/docs/pages/component-library/default-components/icons.mdx index c6f98e71..95c07f75 100644 --- a/fern/products/docs/pages/component-library/default-components/icons.mdx +++ b/fern/products/docs/pages/component-library/default-components/icons.mdx @@ -36,7 +36,7 @@ Add Font Awesome icons to your docs with customizable styles, colors and sizes u Size in 0.25rem increments (e.g., 4 = 1rem)
-## Font Awesome styles +## Font Awesome Styles You can use any Font Awesome style by using either: - Short syntax: `icon="heart"` (defaults to solid) @@ -69,7 +69,7 @@ You can use any Font Awesome style by using either: -## Best practices +## Best Practices - Use icons consistently throughout your documentation - Keep icon sizes appropriate for their context (16-24px for inline, larger for featured items) diff --git a/fern/products/docs/pages/component-library/default-components/overview.mdx b/fern/products/docs/pages/component-library/default-components/overview.mdx index 210e86f7..d0e02d7a 100644 --- a/fern/products/docs/pages/component-library/default-components/overview.mdx +++ b/fern/products/docs/pages/component-library/default-components/overview.mdx @@ -1,5 +1,5 @@ --- -title: 'Components overview' +title: 'Components Overview' description: 'Enhance your docs with our built-in component library. Use components to create interactive and engaging documentation.' --- diff --git a/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx b/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx index b9ce3eaf..86416ca7 100644 --- a/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx +++ b/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx @@ -1,5 +1,5 @@ --- -title: Runnable endpoint +title: Runnable Endpoint description: Test API endpoints directly from your documentation with an interactive request builder. --- diff --git a/fern/products/docs/pages/component-library/default-components/steps.mdx b/fern/products/docs/pages/component-library/default-components/steps.mdx index 9a093385..60156a69 100644 --- a/fern/products/docs/pages/component-library/default-components/steps.mdx +++ b/fern/products/docs/pages/component-library/default-components/steps.mdx @@ -61,13 +61,13 @@ The Steps component helps organize sequential content with automatic numbering, ## Properties -### Steps properties +### Steps Properties Whether to include the steps in the table of contents. Defaults to `false`. -### Step properties +### Step Properties Optional title for the step diff --git a/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx b/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx index c36b0119..fb0cf942 100644 --- a/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx +++ b/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx @@ -1,5 +1,5 @@ --- -title: Fern editor +title: Fern Editor description: Update your docs visually with a GitHub-backed workflow that creates pull requests. --- From b508588432f917b42e61f1ac868616dfdb84ea7f Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 23 Oct 2025 13:57:25 -0400 Subject: [PATCH 08/14] fix vale warnings and sentence case exceptions --- .vale/styles/FernStyles/Acronyms.yml | 15 +++++++++------ .vale/styles/FernStyles/Headings.yml | 9 ++++++++- fern/products/docs/docs.yml | 4 ++-- .../docs/pages/developer-tools/cursor.mdx | 4 ++-- .../docs/pages/integrations/feature-flags.mdx | 2 +- fern/products/docs/pages/navigation/overview.mdx | 2 +- 6 files changed, 23 insertions(+), 13 deletions(-) diff --git a/.vale/styles/FernStyles/Acronyms.yml b/.vale/styles/FernStyles/Acronyms.yml index 9491d7e6..093d745c 100644 --- a/.vale/styles/FernStyles/Acronyms.yml +++ b/.vale/styles/FernStyles/Acronyms.yml @@ -11,12 +11,12 @@ exceptions: - API - ASP - CLI - - CNAME # Fern-specific + - CNAME - CPU - CSS - CSV - DEBUG - - DNS # Fern-specific + - DNS - DOM - DPI - FAQ @@ -56,7 +56,7 @@ exceptions: - TBD - TCP - TODO - - TXT # Fern-specific + - TXT - URI - URL - USB @@ -65,6 +65,9 @@ exceptions: - XSS - YAML - ZIP - - MDX # Fern-specific - - SEO # Fern-specific - - AWS # Fern-specific + - MDX + - SEO + - AWS + - OpenRPC + - gRPC + - RPC diff --git a/.vale/styles/FernStyles/Headings.yml b/.vale/styles/FernStyles/Headings.yml index d397c0eb..aae3aef4 100644 --- a/.vale/styles/FernStyles/Headings.yml +++ b/.vale/styles/FernStyles/Headings.yml @@ -32,4 +32,11 @@ exceptions: - GitHub - README - Action - - Actions \ No newline at end of file + - Actions + - WebSocket + - WebSocket Playground + - OpenRPC + - gRPC + - RPC + - SDK + - SDKs \ No newline at end of file diff --git a/fern/products/docs/docs.yml b/fern/products/docs/docs.yml index 8595344d..300965ea 100644 --- a/fern/products/docs/docs.yml +++ b/fern/products/docs/docs.yml @@ -86,7 +86,7 @@ navigation: - page: Icons path: ./pages/component-library/default-components/icons.mdx icon: fa-duotone fa-icons - - page: Parameter fields + - page: Parameter Fields path: ./pages/component-library/default-components/parameter-fields.mdx icon: fa-duotone fa-list - page: Steps @@ -101,7 +101,7 @@ navigation: - page: Tooltips path: ./pages/component-library/default-components/tooltips.mdx icon: fa-duotone fa-comment - - page: Fern editor + - page: Fern Editor path: ./pages/component-library/writing-content/visual-editor.mdx slug: fern-editor - page: Reusable snippets diff --git a/fern/products/docs/pages/developer-tools/cursor.mdx b/fern/products/docs/pages/developer-tools/cursor.mdx index 25517e11..8492d4be 100644 --- a/fern/products/docs/pages/developer-tools/cursor.mdx +++ b/fern/products/docs/pages/developer-tools/cursor.mdx @@ -103,7 +103,7 @@ Use the following components whenever possible to enhance readability and struct ```` -### Callouts (tips, notes, warnings, etc.) +### Callouts (Tips, Notes, Warnings, etc.) ``` @@ -117,7 +117,7 @@ This Callout uses a title and a custom icon. This brings us a checked status ``` -### Cards & card groups +### Cards & Card Groups ``` ` component to conditionally render content: Default value if the feature flag is not defined -## Example: Complete configuration +## Example: complete configuration ```yaml # docs.yml diff --git a/fern/products/docs/pages/navigation/overview.mdx b/fern/products/docs/pages/navigation/overview.mdx index d16f2347..38d243b4 100644 --- a/fern/products/docs/pages/navigation/overview.mdx +++ b/fern/products/docs/pages/navigation/overview.mdx @@ -277,7 +277,7 @@ layout: ## Versions -If you have multiple versions of your documentation, you can introduce a dropdown version selector by specifying the `versions`. For more information, check out our [documentation on versioning](/learn/docs/building-your-docs/versioning). +If you have multiple versions of your documentation, you can introduce a dropdown version selector by specifying the `versions`. For more information, check out the [documentation on versioning](/learn/docs/building-your-docs/versioning). ## Product switching From 11004301115ad627c3bcb0a7e34e2fcaac87fe87 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 23 Oct 2025 13:59:30 -0400 Subject: [PATCH 09/14] vale checks --- fern/products/docs/pages/navigation/overview.mdx | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/fern/products/docs/pages/navigation/overview.mdx b/fern/products/docs/pages/navigation/overview.mdx index 38d243b4..4b7574e4 100644 --- a/fern/products/docs/pages/navigation/overview.mdx +++ b/fern/products/docs/pages/navigation/overview.mdx @@ -34,11 +34,11 @@ navbar-links: ## Sections, contents, and pages -The navigation organizes your documentation in the left-side nav bar. You can create sections for grouping related content. Each `section` has a name and a list of `contents`. The sections appear in the left-side nav bar in the order that they are listed in `docs.yml`. +The navigation organizes your documentation in the left-side nav bar. You can create sections for grouping related content. Each `section` has a name and a list of `contents`. The sections appear in the left-side nav bar in the order listed in `docs.yml`. In `contents`, list your pages with names and corresponding file paths. The supported file types for pages are `.md` or `.mdx`. -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 do not 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. +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. ```yaml Example navigation config navigation: @@ -79,7 +79,7 @@ navigation: ### 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 will not be indexed. +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. ```yaml Example navigation config with additional section {7, 10} navigation: @@ -281,7 +281,7 @@ If you have multiple versions of your documentation, you can introduce a dropdow ## Product switching -If you have multiple products in your documentation, you can introduce a dropdown product selector 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. +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. ```yaml {2-3, 7-8} @@ -298,5 +298,3 @@ products: subtitle: Product B subtitle # optional ``` - -For more information about setting up this up, check out our [documentation on product switching](/learn/docs/configuration/products). From 22b88a1e50f3c38becbc516706aa50c74544cb48 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 23 Oct 2025 14:04:58 -0400 Subject: [PATCH 10/14] sentence case examples --- .../docs/pages/navigation/overview.mdx | 87 +++++++++++-------- 1 file changed, 50 insertions(+), 37 deletions(-) diff --git a/fern/products/docs/pages/navigation/overview.mdx b/fern/products/docs/pages/navigation/overview.mdx index 4b7574e4..ccb55035 100644 --- a/fern/products/docs/pages/navigation/overview.mdx +++ b/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. +{/* */} ```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 ``` - +{/* */} 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: - +{/* */} ```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 ``` +{/* */} ### 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. +{/* */} ```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 ``` +{/* */} ### 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. +{/* */} ```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 ``` +{/* */} ## 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. +{/* */} ```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 ``` +{/* */} ## Links You can add a link to an external page within your sidebar navigation with the following configuration: +{/* */} ```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/ ``` +{/* */} 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. +{/* */} + ```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 ``` +{/* */} Here's an example of what the Tabs implementation looks like: From 0ab133e047c6db50e8ce91e7a144b89e8b5a5c73 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 23 Oct 2025 14:06:14 -0400 Subject: [PATCH 11/14] nit --- fern/products/docs/pages/navigation/overview.mdx | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/fern/products/docs/pages/navigation/overview.mdx b/fern/products/docs/pages/navigation/overview.mdx index ccb55035..e69b8a38 100644 --- a/fern/products/docs/pages/navigation/overview.mdx +++ b/fern/products/docs/pages/navigation/overview.mdx @@ -12,6 +12,7 @@ Every Fern Docs website has a special configuration file called `docs.yml`. Use Here's a complete example of a `docs.yml` file: + ```yaml # yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json navigation: @@ -21,7 +22,7 @@ navigation: path: ./intro.mdx - page: Authentication path: ./auth.mdx - - api: API reference + - api: API Reference navbar-links: - type: secondary text: Contact support @@ -47,7 +48,7 @@ navigation: contents: - page: My page path: ./pages/my-page.mdx - - api: API reference + - api: API Reference ``` {/* */} 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: path: ./pages/my-page.mdx - 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: @@ -71,7 +72,7 @@ navigation: contents: - page: My page path: ./pages/my-page.mdx - - api: API reference + - api: API Reference - section: Help center contents: - page: Contact us @@ -209,7 +210,7 @@ navigation: - page: My page icon: fa-regular fa-file path: ./pages/my-page.mdx - - api: API reference + - api: API Reference icon: fa-regular fa-puzzle ``` {/* */} @@ -244,7 +245,7 @@ Within the navigation, you can add `tabs`. Tabs are used to group sections toget ```yaml tabs: api: - display-name: API reference + display-name: API Reference icon: puzzle help: display-name: Help center @@ -294,7 +295,7 @@ If you have multiple versions of your documentation, you can introduce a dropdow ## Product switching -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. +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. ```yaml {2-3, 7-8} From 5dd7d0faad33615ec00458f618e28cd33a9568f5 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 23 Oct 2025 14:09:09 -0400 Subject: [PATCH 12/14] fix websocket playground reference --- fern/products/docs/pages/api-references/api-explorer.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/api-references/api-explorer.mdx b/fern/products/docs/pages/api-references/api-explorer.mdx index 0307b5cf..73d615c5 100644 --- a/fern/products/docs/pages/api-references/api-explorer.mdx +++ b/fern/products/docs/pages/api-references/api-explorer.mdx @@ -24,7 +24,7 @@ Allow users to test their calls in a sandbox environment or select the environme
-### WebSocket playground +### WebSocket Playground For APIs that support WebSocket connections, the API Explorer includes a **WebSocket**-specific Playground. The WebSocket Playground also allows users to establish a connection with the API, and send/receive messages in real-time. From 97326c6182c4adcbf0db7399b91a6601e57f7a02 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 23 Oct 2025 14:09:38 -0400 Subject: [PATCH 13/14] fix autopopulate error --- fern/products/docs/pages/api-references/api-explorer.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/docs/pages/api-references/api-explorer.mdx b/fern/products/docs/pages/api-references/api-explorer.mdx index 73d615c5..bbbf5ea8 100644 --- a/fern/products/docs/pages/api-references/api-explorer.mdx +++ b/fern/products/docs/pages/api-references/api-explorer.mdx @@ -5,7 +5,7 @@ subtitle: Reduce "time to 200" by allowing users to make real calls to your API Fern's API Explorer allows users to make authenticated requests to your API without ever leaving your documentation. -### Auto-populate with examples +### Autopopulate with examples Fern will automatically populate the fields of the endpoint with the values set in your API specification.
From 992496e508e2d19904e5521f54296d85f0d7ca6e Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Thu, 23 Oct 2025 14:26:54 -0400 Subject: [PATCH 14/14] sentence case overview cards --- fern/products/docs/pages/getting-started/overview.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/fern/products/docs/pages/getting-started/overview.mdx b/fern/products/docs/pages/getting-started/overview.mdx index 8d333869..1cade7aa 100644 --- a/fern/products/docs/pages/getting-started/overview.mdx +++ b/fern/products/docs/pages/getting-started/overview.mdx @@ -93,7 +93,7 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
- Bring your own API Spec + Bring your own API spec Arrow right light Arrow right light
@@ -144,7 +144,7 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
- Fern's MCP Server + Fern's MCP server Arrow right light Arrow right light