Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dsinghvi
Copy link
Member

@dsinghvi dsinghvi commented May 3, 2024

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

Copy link

github-actions bot commented May 3, 2024

@dannysheridan dannysheridan self-requested a review May 3, 2024 21:25
@dannysheridan
Copy link
Member

dannysheridan commented May 3, 2024

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
Copy link
Member

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

@abvthecity
Copy link
Contributor

abvthecity commented May 6, 2024

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

@dannysheridan
Copy link
Member

turning this into docs.yml:

  - tab: docs
    layout:
      - section: Getting Started
        contents:
          - page: Quickstart
            path: ./pages/docs/getting-started/quickstart.mdx
          - page: Project Structure
            path: ./pages/docs/getting-started/project-structure.mdx
          - page: Showcase
            path: ./pages/docs/getting-started/showcase.mdx
      - section: Building your Docs
        contents:
          - section: Navigation
            contents:
              - page: Sections
                path: ./pages/docs/building-your-docs/navigation/sections.mdx
              - page: Tabs
                path: ./pages/docs/building-your-docs/navigation/tabs.mdx
              - page: Versions
                path: ./pages/docs/building-your-docs/navigation/versions.mdx
              - page: API Reference
                path: ./pages/docs/building-your-docs/navigation/api-reference.mdx
              - page: Search
                path: ./pages/docs/building-your-docs/navigation/search.mdx
          - section: Customization
            contents:
              - page: Theme
                path: ./pages/docs/building-your-docs/customization/theme.mdx
              - page: Fonts
                path: ./pages/docs/building-your-docs/customization/fonts.mdx
              - page: Layout
                path: ./pages/docs/building-your-docs/customization/layout.mdx
              - page: Header & Footer [pro]
                path: ./pages/docs/building-your-docs/customization/header-footer.mdx
              - page: Custom CSS [pro]
                path: ./pages/docs/building-your-docs/customization/custom-css.mdx
              - page: Custom JS [pro]
                path: ./pages/docs/building-your-docs/customization/custom-js.mdx
          - section: Writing Content
            contents:
              - page: Using Markdown
                path: ./pages/docs/building-your-docs/writing-content/markdown.mdx
              - page: Using MDX/JSX
                path: ./pages/docs/building-your-docs/writing-content/mdx-jsx.mdx
              - page: Frontmatter
                path: ./pages/docs/building-your-docs/writing-content/frontmatter.mdx
              - page: Reusable Snippets
                path: ./pages/docs/building-your-docs/writing-content/reusable-snippets.mdx
              - page: Versioning
                path: ./pages/docs/building-your-docs/writing-content/versioning.mdx
          - section: Previewing
            contents:
              - page: Local Preview
                path: ./pages/docs/building-your-docs/previewing/local-preview.mdx
              - page: PR Previews
                path: ./pages/docs/building-your-docs/previewing/pr-previews.mdx
          - section: API Reference
            contents:
              - page: Using OpenAPI
                path: ./pages/docs/building-your-docs/api-reference/openapi.mdx
              - page: Using Fern Definition
                path: ./pages/docs/building-your-docs/api-reference/fern-definition.mdx
              - page: Using MDX
                path: ./pages/docs/building-your-docs/api-reference/using-mdx.mdx
              - page: API Playground
                path: ./pages/docs/building-your-docs/api-reference/api-playground.mdx
              - page: API Key Injection
                path: ./pages/docs/building-your-docs/api-reference/api-key-injection.mdx
          - section: Custom Domain
            contents:
              - page: Custom Subdomain
                path: ./pages/docs/building-your-docs/custom-domain/custom-subdomain.mdx
              - page: Custom Subpath
                path: ./pages/docs/building-your-docs/custom-domain/custom-subpath.mdx
      - section: Features
        contents:
          - page: Search by Algolia
            path: ./pages/docs/features/search-algolia.mdx
          - page: AI Chatbot
            path: ./pages/docs/features/ai-chatbot.mdx
          - section: Protect Your Docs
            contents:
              - page: Password-protected
                path: ./pages/docs/features/protect-your-docs/password-protected.mdx
              - page: SSO
                path: ./pages/docs/features/protect-your-docs/sso.mdx
          - page: Connecting Analytics
            path: ./pages/docs/features/connecting-analytics.mdx
      - section: Components
        contents:
          - page: Built-in Components
            path: ./pages/docs/components/built-in.mdx
          - page: Custom Components
            path: ./pages/docs/components/custom.mdx
      - section: Comparing
        contents:
          - page: Fern to Mintlify
            path: ./pages/docs/comparing/fern-to-mintlify.mdx
          - page: Fern to ReadMe
            path: ./pages/docs/comparing/fern-to-readme.mdx

@dannysheridan
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants