fern icon indicating copy to clipboard operation
fern copied to clipboard

Published 20 hours ago • verified publisher icon fern-api

(fix, docs): adapt all the middle content we have on the docs product

Open dsinghvi opened this issue 9 months ago • 5 comments

We don't really cover much in the docs about Ferns docs product. This PR attempts to change that. The updated information architecture looks like this:

Screenshot 2024-05-03 at 3 48 26 PM

dsinghvi avatar May 03 '24 20:05 dsinghvi

🌿 Preview your docs: https://fern-preview-2b53468f-1744-48b4-902c-7e1c0a4aca52.docs.buildwithfern.com

github-actions[bot] avatar May 03 '24 20:05 github-actions[bot]

Getting Started

  • Quickstart
  • Project Structure (docs.yml, fern folder, fern.config.json, GitHub as CMS)
  • Showcase

Building your Docs

  • Styling -- Colors -- Fonts -- Light/Dark Mode
  • Writing Content -- Using Markdown -- Using MDX/JSX -- Frontmatter -- Reusable Snippets -- Versioning
  • Previewing -- Local Preview -- PR Previews
  • API Reference -- Using OpenAPI -- Using Fern Definition -- Using MDX -- API Playground -- API Key Injection
  • Scripts -- Custom CSS -- Custom JS
  • Custom Domain -- Custom Subdomain -- Custom Subpath

Features

  • Search by Algolia
  • AI Chatbot
  • Protect Your Docs -- Password-protected -- SSO
  • Connecting Analytics

Components

  • Built-in Components
  • Custom Components

Comparing

  • Fern to Mintlify
  • Fern to ReadMe

dannysheridan avatar May 03 '24 21:05 dannysheridan

Opinion: the showcase cards should tell a user what to look for. (e.g., Primer -> Versioning)

dannysheridan avatar May 03 '24 21:05 dannysheridan

Getting Started

  • Quickstart
  • Project Structure (docs.yml, fern folder, fern.config.json, GitHub as CMS)
  • Showcase

Building your Docs

  • Navigation
    • Sections
    • Tabs
    • Versions
    • API Reference
    • Search
  • Customization
    • Theme (includes colors, light/dark mode)
    • Fonts
    • Layout (widths, heights, placement)
    • [pro] Header & Footer
    • [pro] Custom CSS
    • [pro] Custom JS
  • Writing Content
    • Using Markdown
    • Using MDX/JSX
    • Frontmatter
    • Reusable Snippets
    • Versioning
  • Previewing
    • Local Preview
    • PR Previews
  • API Reference
    • Using OpenAPI
    • Using Fern Definition
    • Using MDX
    • API Playground
    • API Key Injection
  • Custom Domain
    • Custom Subdomain
    • Custom Subpath

Features

  • Search by Algolia
  • AI Chatbot
  • Protect Your Docs
    • Password-protected
    • SSO
  • Connecting Analytics

Components

  • Built-in Components
  • Custom Components

Comparing

  • Fern to Mintlify
  • Fern to ReadMe

abvthecity avatar May 06 '24 15:05 abvthecity

Getting Started

  • Quickstart
  • Project Structure (docs.yml, fern folder, fern.config.json, GitHub as CMS)
  • Showcase

Building your Docs

  • Navigation
    • Sections
    • Tabs
    • Versions
    • API Reference
    • Search
  • Customization
    • Theme (includes colors, light/dark mode)
    • Fonts
    • Layout (widths, heights, placement)
    • [pro] Header & Footer
    • [pro] Custom CSS
    • [pro] Custom JS
  • Writing Content
    • Using Markdown
    • Using MDX/JSX
    • Frontmatter
    • Reusable Snippets
    • Versioning
  • Previewing
    • Local Preview
    • PR Previews
  • API Reference
    • Using OpenAPI
    • Using Fern Definition
    • Using MDX
    • API Playground
    • API Key Injection
  • Custom Domain
    • Custom Subdomain
    • Custom Subpath

Features

  • Search by Algolia
  • AI Chatbot
  • Protect Your Docs
    • Password-protected
    • SSO
  • Analytics
    • Google Analytics
    • Segment
    • Mixpanel
    • PostHog
  • Integrations
    • GitHub
    • Intercom
    • HubSpot
    • Slack
  • SEO

Components

  • Built-in Components
  • Custom Components

Comparing

  • Fern vs Mintlify
  • Fern vs ReadMe

dannysheridan avatar May 06 '24 22:05 dannysheridan