Redirects for SDKs, Added product areas for Fern Def & OpenAPI Def (#74)

Co-authored-by: Kapil Gowru <[email protected]>
Co-authored-by: Kapil Gowru <[email protected]>
Co-authored-by: Kapil Gowru <[email protected]>

Author: 4 people

fern/assets/styles.css

@@ -92,7 +92,7 @@
       grid-row: 2;
     }
 
-    > a[href*="api-definition"]:before {
+    /* > a[href*="api-definition"]:before {
       content: "Utilities";
       font-weight: 500;
       position: absolute;
@@ -108,19 +108,7 @@
         width: 1.5rem;
         height: 1.5rem;
       }
-    }
-
-
-    > a[href*="cli-api-reference"] {
-      grid-column: 3;
-      grid-row: 2;
-      transform: translateY(-32px);
-
-      .fern-selection-item-icon {
-        width: 1.5rem;
-        height: 1.5rem;
-      }
-    }
+    } */
 
     > a[href*="openapi"]:before {
       content: "Supported Specs";
@@ -151,6 +139,17 @@
       }
     }
 
+    > a[href*="cli-api-reference"] {
+      grid-column: 3;
+      grid-row: 3;
+      transform: translateY(-64px);
+
+      .fern-selection-item-icon {
+        width: 1.5rem;
+        height: 1.5rem;
+      }
+    }
+
     > a[href*="asyncapi"] {
       grid-column: 3;
       grid-row: 3;

fern/docs.yml

@@ -27,35 +27,36 @@ products:
 
   - display-name: Ask Fern
     path: ./products/ask-fern/ask-fern.yml
-    icon: fa-regular fa-magnifying-glass
+    icon: fa-regular fa-magnifying-glass  
     image: ./images/product-switcher/product-switcher-askfern-light.png
     slug: ask-fern
     subtitle: Let users find answers in your documentation instantly
 
-  - display-name: API Definition
-    path: ./products/api-definition/api-definition.yml
+
+  # - display-name: API Definition
+  #   path: ./products/api-definition/api-definition.yml
+  #   icon: fa-regular fa-book
+  #   image: ./images/product-switcher/api-definitions-light.png
+  #   slug: api-definition
+
+  - display-name: OpenAPI
+    path: ./products/openapi-def/openapi-def.yml
     icon: fa-regular fa-book
-    image: ./images/product-switcher/api-definitions-light.png
-    slug: api-definition
+    image: ./images/product-switcher/openapi-def.png
+    slug: openapi
+  
+  - display-name: Fern Definition
+    path: ./products/fern-def/fern-def.yml
+    icon: fa-regular fa-seedling
+    image: ./images/product-switcher/fern-def.png
+    slug: fern-def
 
   - display-name: CLI & API Reference
     path: ./products/cli-api-reference/cli-api-reference.yml
     icon: fa-regular fa-terminal
     image: ./images/product-switcher/cli-api-reference-light.png
     slug: cli-api-reference
 
-  # - display-name: OpenAPI
-  #   path: ./products/openapi-def/openapi-def.yml
-  #   icon: fa-regular fa-book
-  #   image: ./images/product-switcher/openapi-def.png
-  #   slug: openapi
-  
-  # - display-name: Fern Definition
-  #   path: ./products/fern-def/fern-def.yml
-  #   icon: fa-regular fa-seedling
-  #   image: ./images/product-switcher/fern-def.png
-  #   slug: fern-def
-  
   # - display-name: AsyncAPI
   #   path: ./products/asyncapi-def/asyncapi-def.yml
   #   icon: fa-regular fa-bolt
@@ -152,27 +153,66 @@ redirects:
   - source: /learn/welcome
     destination: /learn
     permanent: true
-  - source: /learn/home
-    destination: /learn
+  - source: /learn
+    destination: /learn/home
     permanent: true
   - source: /learn/api-definition/fern/api-yml-reference
     destination: /learn/api-definition/fern/api-yml/overview
     permanent: true
+  - source: /learn/docs/api-references/api-explorer
+    destination: /learn/docs/api-references/api-explorer/overview
   - source: /learn/docs/api-references/api-playground/:slug*
-    destination: /learn/docs/api-references/api-explorer/:slug*
+    destination: learn/docs/api-references/api-explorer/:slug*
     permanent: true
   - source: /learn/docs/api-references/api-playground
-    destination: /learn/docs/api-references/api-explorer
+    destination: /learn/docs/api-references/api-explorer/overview
     permanent: true
   - source: /learn/sdks/features/:slug*
     destination: /learn/sdks/capabilities/:slug*
     permanent: true
+  - source: /learn/sdks/capabilities/method-names
+    destination: /learn/sdks/deep-dives/customize-method-names
+    permanent: true
+  - source: /learn/sdks/guides/preview-your-sdk-locally
+    destination: /learn/sdks/deep-dives/setup-local-sdk-previews
+    permanent: true
+  - source: /learn/sdks/capabilities/auto-pagination
+    destination: /learn/v2/sdks/deep-dives/configure-auto-pagination
+    permanent: true
+  - source: /learn/sdks/capabilities/idempotency-headers
+    destination: /learn/sdks/deep-dives/configure-idempotency
+    permanent: true
   - source: /learn/sdks/package-managers/:slug*
     destination: /learn/sdks/guides/publish-to-package-managers/:slug*
     permanent: true
+  - source: /learn/sdks/guides/publish-to-package-managers/npm-type-script
+    destination: /learn/sdks/generators/type-script/publishing-to-npm
+    permanent: true
+  - source: /learn/sdks/guides/publish-to-package-managers/pypi
+    destination: /learn/sdks/generators/python/publishing-to-py-pi
+    permanent: true
+  - source: /learn/sdks/guides/publish-to-package-managers/nuget
+    destination: /learn/sdks/generators/net/publishing-to-nu-get
+    permanent: true
+  - source: /learn/sdks/guides/publish-to-package-managers/pkgsite
+    destination: /learn/sdks/generators/go/publishing-as-a-go-module
+    permanent: true
+  - source: /learn/sdks/guides/publish-to-package-managers/maven-central
+    destination: /learn/sdks/generators/java/publishing-to-maven-central
+    permanent: true
+  - source: /learn/sdks/guides/publish-to-package-managers/rubygems
+    destination: /learn/sdks/generators/ruby/publishing-to-rubygems
+    permanent: true
+  - source: /learn/sdks/guides/publish-to-package-managers/packagist
+    destination: /learn/sdks/generators/php/publishing-to-packagist
+    permanent: true
   - source: /learn/sdks/introduction/configuration
     destination: /learn/sdks/introduction/language-support
     permanent: true
+  - source: /learn/sdks/introduction/language-support
+    destination: /learn/sdks/overview/introduction
+    permanent: true
+  ## PAUSED HERE
   - source: /learn/sdks/getting-started/:slug*
     destination: /learn/sdks/guides/:slug*
     permanent: true

fern/products/docs/docs.yml

@@ -115,8 +115,9 @@ navigation:
         path: ./pages/api-references/http-snippets.mdx
       - section: API Explorer
         slug: api-explorer
-        path: ./pages/api-references/api-explorer.mdx
         contents:
+          - page: Overview
+            path: ./pages/api-references/api-explorer.mdx
           - page: Auto-populate API Keys
             path: ./pages/api-references/autopopulate-api-key.mdx
       - page: Endpoint Errors

fern/products/fern-def/fern-def.yml

@@ -1,55 +1,55 @@
 navigation:
-  - section: Getting Started
+  - page: Overview
+    path: ./pages/overview.mdx
+  - page: Authentication
+    path: ./pages/auth.mdx
+  - page: Types
+    path: ./pages/types.mdx
+  - section: Endpoints
+    path: ./pages/endpoints.mdx
+    contents: 
+      - page: HTTP JSON Endpoints
+        path: ./pages/endpoints/rest.mdx
+        slug: http
+      - page: Multipart Form Uploads
+        path: ./pages/endpoints/multipart.mdx
+        slug: multipart
+      - page: Bytes
+        path: ./pages/endpoints/bytes.mdx
+        slug: bytes                
+      - page: Server-Sent Events
+        path: ./pages/endpoints/sse.mdx
+        slug: sse
+  - page: Webhooks
+    path: ./pages/webhooks.mdx
+  - page: WebSockets
+    path: ./pages/websockets.mdx
+    slug: websockets
+  - page: Errors
+    path: ./pages/errors.mdx
+  - page: Imports
+    path: ./pages/imports.mdx
+  - page: Examples
+    path: ./pages/examples.mdx
+  - page: Audiences
+    path: ./pages/audiences.mdx
+  - page: Availability
+    path: ./pages/availability.mdx
+  - section: api.yml Reference
+    slug: api-yml
     contents:
       - page: Overview
-        path: ./pages/getting-started/overview.mdx
-      - page: Quickstart
-        path: ./pages/getting-started/quickstart.mdx
-      - page: Philosophy
-        path: ./pages/getting-started/philosophy.mdx
-      - page: Customer Showcase
-        path: ./pages/getting-started/customer-showcase.mdx
-  - section: Global Settings
-    contents:
-      - page: Authentication
-        path: ./pages/global-settings/authentication.mdx
-      - page: Global Headers
-        path: ./pages/global-settings/global-headers.mdx
+        path: ./pages/api-yml/overview.mdx
       - page: Environments
-        path: ./pages/global-settings/environments.mdx
-      - page: API Versions
-        path: ./pages/global-settings/api-versions.mdx
-  - section: Defining your API
-    contents:
-      - page: Types
-        path: ./pages/defining-your-api/types.mdx
-      - page: Imports
-        path: ./pages/defining-your-api/imports.mdx
-      - page: Endpoints
-        path: ./pages/defining-your-api/endpoints.mdx
-      - page: Webhooks
-        path: ./pages/defining-your-api/webhooks.mdx
-      - page: WebSockets
-        path: ./pages/defining-your-api/websockets.mdx
-      - page: Examples
-        path: ./pages/defining-your-api/examples.mdx
+        path: ./pages/api-yml/environments.mdx
+      - page: Global Headers
+        path: ./pages/api-yml/global-configuration.mdx
       - page: Errors
-        path: ./pages/defining-your-api/errors.mdx
-      - page: Doc
-        path: ./pages/defining-your-api/doc.mdx
-      - page: Availability
-        path: ./pages/defining-your-api/availability.mdx
-      - page: Audiences
-        path: ./pages/defining-your-api/audiences.mdx
-  - section: Guides
-    contents:
-      - page: Validate your Fern Definition
-        path: ./pages/guides/validate-your-fern-definition.mdx
-      - page: Define multiple APIs
-        path: ./pages/guides/define-multiple-apis.mdx
-      - page: Export to OpenAPI
-        path: ./pages/guides/export-to-openapi.mdx
-      - page: Depending on other APIs
-        path: ./pages/guides/depending-on-other-apis.mdx
-      - page: Creating namespaces
-        path: ./pages/guides/creating-namespaces.mdx
+        path: ./pages/api-yml/errors.mdx
+  - page: Packages
+    path: ./pages/packages.mdx
+  - page: Depending on Other APIs
+    path: ./pages/depending-on-other-apis.mdx
+  - page: Export to OpenAPI
+    slug: export-openapi
+    path: ./pages/export-openapi.mdx