docs: re-organise into tabs with upgraded fern and pr previews (#354)

* docs: re-organise into tabs & add a PR preview for docs

* update slack support status

* fix 500 error on fern previews & update redirects

* fix api reference link

* update ci workflow

* fix production docs url

.github/workflows/deploy-fern-docs.yml

@@ -25,9 +25,13 @@ jobs:
             - name: Install Dependencies
               run: yarn install
 
-            - name: Generate docs & postman collection
+            - name: Generate postman collection
               run: fern generate --group external
               env:
                   POSTMAN_API_KEY: ${{ secrets.POSTMAN_API_KEY }}
                   POSTMAN_WORKSPACE_ID: ${{ secrets.POSTMAN_WORKSPACE_ID }}
                   FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+            - name: Generate Production Docs
+              env:
+                  FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+              run: fern generate --docs --instance revert.docs.buildwithfern.com --log-level debug

.github/workflows/preview-docs.yml

@@ -0,0 +1,28 @@
+name: preview-docs
+
+on:
+    pull_request:
+        branches:
+            - main
+
+jobs:
+    generate-preview-docs:
+        name: Generate Documentation Preview
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18'
+
+            - name: Install Fern
+              run: npm install -g fern-api
+
+            - name: Generate Documentation Preview with Fern
+              env:
+                  FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
+              run: fern generate --docs --preview

README.md

@@ -79,7 +79,8 @@ CRMs:
 
 Communication tools:
 
--   [ ] Slack
+-   [x] Slack
+-   [ ] Discord
 -   [ ] Microsoft Teams
 
 Accounting software:

fern/docs.yml

@@ -0,0 +1,78 @@
+title: Revert | API Docs
+instances:
+    - url: revert.docs.buildwithfern.com
+      custom-domain: docs.revert.dev
+tabs:
+    help:
+        display-name: Overview
+        icon: 'fa-solid fa-globe'
+    api:
+        display-name: API Reference
+        icon: 'fa-solid fa-code'
+navigation:
+    - tab: help
+      layout:
+          - section: Introduction
+            contents:
+                - page: Getting Started
+                  path: ./docs/contents/intro.mdx
+          - section: Quick Start
+            contents:
+                - page: Quick Start
+                  path: ./docs/contents/quick-start.mdx
+          - section: Use Cases
+            contents:
+                - page: Use Cases
+                  path: ./docs/contents/usecases.mdx
+          - section: How it works
+            contents:
+                - page: How it works
+                  path: ./docs/contents/how-it-works.mdx
+          - section: Rate Limits
+            contents:
+                - page: Rate limits
+                  path: ./docs/contents/rate-limits.mdx
+          - section: Pagination
+            contents:
+                - page: Pagination
+                  path: ./docs/contents/pagination.mdx
+          - section: API Versioning
+            contents:
+                - page: API Versioning
+                  path: ./docs/contents/versioning.mdx
+          - section: Webhooks
+            contents:
+                - page: Webhooks
+                  path: ./docs/contents/webhooks.mdx
+          - section: Developer Guide
+            contents:
+                - page: Developer Guide
+                  path: ./docs/contents/developer-guides.mdx
+          - section: CRM Support
+            contents:
+                - page: CRM Support
+                  path: ./docs/contents/crm-supported.mdx
+          - section: Messaging tools Support
+            contents:
+                - page: Messaging tools Support
+                  path: ./docs/contents/messaging-supported.mdx
+    - tab: api
+      layout:
+          - api: API Reference
+colors:
+    accentPrimary: '#ffffff'
+logo:
+    dark: ./docs/assets/logo.png
+    light: ./docs/assets/logo.png
+    href: https://revert.dev
+favicon: ./docs/assets/favicon.ico
+navbar-links:
+    - type: secondary
+      text: Star us on Github ⭐
+      url: https://github.com/revertinc/Revert
+    - type: secondary
+      text: Join our discord
+      url: https://discord.gg/q5K5cRhymW
+    - type: primary
+      text: Book a demo
+      url: https://calendly.com/jatin-revert-dev/30min

fern/api/docs/mdx/intro.mdx → fern/docs/contents/intro.mdx

@@ -22,7 +22,7 @@ Your customers authenticate their tools with us using our drop-in UI that you ca
 Feeling like an eager beaver? Jump in to the quick start docs and make your first request:
 
 <Cards center>
-    <Card title="Quick Start" href="/quick-start" />
+    <Card title="Quick Start" href="/overview/quick-start" />
 </Cards>
 
 ### Want to deep dive?

fern/api/docs/mdx/quick-start.mdx → fern/docs/contents/quick-start.mdx

@@ -24,6 +24,10 @@ This will serve as a test if the connection is successful or not and if you have
 Here's our official set of SDKs that we support on the frontend to make it super easy to get started.
 
 <Cards center>
-    <Card title="React/Next.js" href="https://www.npmjs.com/package/@revertdotdev/revert-react" />
-    <Card title="Vue.js" href="https://www.npmjs.com/package/@revertdotdev/revert-vue" />
+    <Card
+        title="React/Next.js"
+        icon="fa-brands fa-react"
+        href="https://www.npmjs.com/package/@revertdotdev/revert-react"
+    />
+    <Card title="Vue.js" icon="fa-brands fa-vuejs" href="https://www.npmjs.com/package/@revertdotdev/revert-vue" />
 </Cards>

fern/api/docs/mdx/usecases.mdx → fern/docs/contents/usecases.mdx

@@ -25,5 +25,5 @@ Here are a few business use cases Revert APIs solve for with the suite of unifie
     Push the results back to the CRM as custom fields and objects, boosting your revenue intelligence and ensuring a seamless data flow.
 
 <Cards center>
-    <Card title="Check CRMs supported" href="/crm-support" />
+    <Card title="Check CRMs supported" href="/overview/crm-support" />
 </Cards>

fern/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization": "revert",
-  "version": "0.12.0"
+  "version": "0.15.0-rc70"
 }

package.json

@@ -15,6 +15,10 @@
     },
     "scripts": {
         "fern": "fern generate --log-level debug --group local",
+        "fern-check": "fern check",
+        "fern-format": "fern format",
+        "fern-upgrade": "fern upgrade --rc",
+        "fern-docs:preview": "fern generate --docs --preview",
         "fern-docs": "fern generate --group external",
         "build": "yarn workspaces foreach run build",
         "prepare": "husky install",
@@ -26,4 +30,4 @@
         "seed": "ts-node --transpile-only ./packages/backend/prisma/seed.ts"
     },
     "packageManager": "[email protected]"
-}
+}