Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

> "Break any of these rules sooner than say anything outright barbarous."
>
Expand Down
4 changes: 2 additions & 2 deletions fern/products/ask-fern/ask-fern.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
navigation:
- section: Getting Started
- section: Getting started
contents:
- page: What is Ask Fern?
path: ./pages/getting-started/what-is-ask-fern.mdx
Expand All @@ -15,7 +15,7 @@ navigation:
path: ./pages/features/citations.mdx
- page: Custom FAQs
path: ./pages/features/custom-faqs.mdx
- api: API Reference
- api: API reference
api-name: fai
icon: fa-regular fa-pro
paginated: true
Expand Down
6 changes: 3 additions & 3 deletions fern/products/cli-api-reference/cli-api-reference.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
navigation:
- section: CLI Reference
contents:
- page: Get Started with Fern CLI
- page: Get started with Fern CLI
path: ./pages/cli-get-started.mdx
slug: overview
- page: Global Options
- page: Global options
path: ./pages/global-options.mdx
slug: options
- page: Commands
path: ./pages/commands.mdx
- changelog: ./cli-changelog
- api: API Reference
- api: API reference
api-name: public-api
icon: fa-regular fa-pro
paginated: true
Expand Down
85 changes: 44 additions & 41 deletions fern/products/docs/docs.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,33 @@
navigation:
- section: Getting Started
- section: Getting started
contents:
- page: Overview
path: ./pages/getting-started/overview.mdx
- page: Quickstart
path: ./pages/getting-started/quickstart.mdx
- page: Project Structure
- page: Project structure
path: ./pages/getting-started/project-structure.mdx
- link: Customer Showcase
- link: Customer showcase
href: https://buildwithfern.com/showcase#docs-customers.alldocs-features
- changelog: ./pages/changelog
icon: fa-regular fa-clock-rotate-left
- section: Writing Content
- section: Configuration
contents:
- page: What is docs.yml?
path: ./pages/customization/what-is-docs-yml.mdx
- page: Navigation
path: ./pages/navigation/overview.mdx
- page: Versions
path: ./pages/navigation/versions.mdx
- page: Products
path: ./pages/navigation/products.mdx
- page: Page-level settings
path: ./pages/customization/frontmatter.mdx
- section: Writing content
contents:
- page: Markdown
- page: Markdown pages
path: ./pages/component-library/writing-content/markdown.mdx
slug: markdown
- section: Components
contents:
- page: Overview
Expand Down Expand Up @@ -79,26 +92,16 @@ navigation:
icon: fa-duotone fa-comment
- page: Visual Editor
path: ./pages/component-library/writing-content/visual-editor.mdx
- page: Reusable Markdown
- page: Reusable snippets
path: ./pages/component-library/custom-components/reusable-markdown.mdx
- page: Custom React Components
slug: reusable-markdown
- page: Custom React components
path: ./pages/component-library/custom-components/custom-react-components.mdx
- page: Conditionally Rendered Content
- page: Conditionally rendered content
hidden: true
path: ./pages/component-library/custom-components/conditional-rendering.mdx
- section: Configuration
contents:
- page: What is docs.yml
path: ./pages/customization/what-is-docs-yml.mdx
- page: Navigation
path: ./pages/navigation/overview.mdx
- page: Versions
path: ./pages/navigation/versions.mdx
- page: Products
path: ./pages/navigation/products.mdx
- page: Page-level settings
path: ./pages/customization/frontmatter.mdx
- section: Preview & Publish

- section: Preview & publish
collapsed: true
contents:
- page: Previewing changes locally
Expand All @@ -112,58 +115,58 @@ navigation:
- section: Customization
collapsed: true
contents:
- page: Announcement Banner
- page: Announcement banner
path: ./pages/navigation/announcement-banner.mdx
- page: Changelogs
path: ./pages/navigation/changelogs.mdx
- page: Hiding Content
- page: Hiding content
path: ./pages/navigation/hiding-content.mdx
- page: Search
path: ./pages/customization/search.mdx
- page: User Feedback
- page: User feedback
path: ./pages/customization/user-feedback.mdx
- page: Custom CSS & JS
path: ./pages/component-library/custom-components/custom-css-js.mdx
- section: API References
- section: API references
collapsed: true
contents:
- page: Generate API Reference
- page: Generate API reference
path: ./pages/api-references/generate-api-ref.mdx
slug: generate-api-ref
- page: SDK Snippets
- page: SDK snippets
path: ./pages/api-references/sdk-snippets.mdx
- page: HTTP Snippets
- page: HTTP snippets
path: ./pages/api-references/http-snippets.mdx
- section: API Explorer
slug: api-explorer
contents:
- page: Overview
path: ./pages/api-references/api-explorer.mdx
- page: Auto-populate API Keys
- page: Auto-populate API keys
path: ./pages/api-references/autopopulate-api-key.mdx
- page: Endpoint Errors
- page: Endpoint errors
path: ./pages/api-references/endpoint-errors.mdx
- page: Audiences
path: ./pages/api-references/audiences.mdx
- page: Customize API Reference Layout
- page: Customize API reference layout
path: ./pages/api-references/customize-api-ref.mdx
- page: Write Markdown in API Reference
- page: Write Markdown in API reference
path: ./pages/api-references/api-ref-content.mdx
- page: Generate Webhook Reference
- page: Generate Webhook reference
path: ./pages/api-references/generate-webhook-ref.mdx
- page: Multiple Server URLs
- page: Multiple server URLs
path: ./pages/api-references/server-urls.mdx
slug: server-urls
- page: Generate WebSocket Reference
- page: Generate WebSocket reference
path: ./pages/api-references/generate-websocket-ref.mdx
slug: generate-websocket-ref
- page: Generate OpenRPC Reference
- page: Generate OpenRPC reference
path: ./pages/api-references/generate-openrpc-ref.mdx
slug: generate-openrpc-ref
- section: SEO
collapsed: true
contents:
- page: Configuring Slugs
- page: Configuring slugs
path: ./pages/seo/configuring-slugs.mdx
- page: Redirects
path: ./pages/seo/redirects.mdx
Expand All @@ -177,11 +180,11 @@ navigation:
- page: Role based access control (RBAC)
path: ./pages/authentication/rbac.mdx
slug: rbac
- page: API Key Injection
- page: API key injection
path: ./pages/api-references/autopopulate-api-key.mdx
- page: SSO
path: ./pages/authentication/sso.mdx
- section: Self-Hosted
- section: Self-hosted
collapsed: true
contents:
- page: Overview
Expand Down Expand Up @@ -210,9 +213,9 @@ navigation:
path: ./pages/integrations/support/intercom.mdx
- page: Postman
path: ./pages/integrations/postman.mdx
- page: LaunchDarkly Feature Flags
- page: LaunchDarkly feature flags
path: ./pages/integrations/feature-flags.mdx
- section: Developer Tools
- section: Developer tools
collapsed: true
contents:
- page: Cursor
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/developer-tools/view-markdown.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: View Markdown
description: Learn how to view the Markdown underlying a documentation page, to help with tool integration and troubleshooting.
---

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

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

Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ subtitle: A website builder for beautiful agent and developer-friendly docs.
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
</div>
<div class="text-(color:--grayscale-a11) font-light">
<p>A personalized chatbot that can answer questions about your documentation.</p>
<p>Get instant answers to questions about your docs from a personalized chatbot.</p>
</div>
</div>
</div>
Expand Down
Loading