Add Mintlify Docs (#196)

maticzav · Jan 14, 2024 · 301f090 · 301f090
1 parent 778b5ec
commit 301f090
Show file tree

Hide file tree

Showing 81 changed files with 2,827 additions and 2,686 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,7 @@
+# Mintlify Starter Kit
+
+Run the following command at the root of your documentation (where mint.json is)
+
+```
+pnpm mintlify dev
+```
diff --git a/docs/_snippets/snippet-example.mdx b/docs/_snippets/snippet-example.mdx
@@ -0,0 +1,3 @@
+## My Snippet
+
+<Info>This is an example of a reusable snippet</Info>
diff --git a/website/docs/advanced/cache.mdx → docs/advanced/cache.mdx b/website/docs/advanced/cache.mdx → docs/advanced/cache.mdx
@@ -18,7 +18,6 @@ SwiftGraphQL's cache works like cache in the browser - once you've queried somet
 
 Each SwiftGraphQL query contains a deterministic key that's constructed from the selection and variables.
 
-<!-- Image? -->
 
 Once a result comes in, it's indefinitely cached using this key. Therefore, if you send the same query again, we check the in-memory cache for possible existing results and use them instead.
 

diff --git a/website/docs/advanced/exchanges.mdx → docs/advanced/exchanges.mdx b/website/docs/advanced/exchanges.mdx → docs/advanced/exchanges.mdx
diff --git a/website/docs/advanced/how.mdx → docs/advanced/how.mdx b/website/docs/advanced/how.mdx → docs/advanced/how.mdx
diff --git a/website/docs/advanced/scalars.mdx → docs/advanced/scalars.mdx b/website/docs/advanced/scalars.mdx → docs/advanced/scalars.mdx
diff --git a/website/docs/advanced/selection.mdx → docs/advanced/selection.mdx b/website/docs/advanced/selection.mdx → docs/advanced/selection.mdx
diff --git a/website/docs/errors.mdx → docs/errors.mdx b/website/docs/errors.mdx → docs/errors.mdx
diff --git a/website/docs/faq.mdx → docs/faq.mdx b/website/docs/faq.mdx → docs/faq.mdx
diff --git a/docs/favicon.svg b/docs/favicon.svg
diff --git a/website/docs/guides/auth.mdx → docs/guides/auth.mdx b/website/docs/guides/auth.mdx → docs/guides/auth.mdx
diff --git a/website/docs/guides/filestructure.mdx → docs/guides/filestructure.mdx b/website/docs/guides/filestructure.mdx → docs/guides/filestructure.mdx
diff --git a/website/docs/guides/uploads.mdx → docs/guides/uploads.mdx b/website/docs/guides/uploads.mdx → docs/guides/uploads.mdx
diff --git a/website/public/assets/client.png → docs/images/client.png b/website/public/assets/client.png → docs/images/client.png
diff --git a/website/public/assets/collisions.png → docs/images/collisions.png b/website/public/assets/collisions.png → docs/images/collisions.png
diff --git a/website/public/assets/compile.png → docs/images/compile.png b/website/public/assets/compile.png → docs/images/compile.png
diff --git a/website/public/assets/hero.png → docs/images/hero.png b/website/public/assets/hero.png → docs/images/hero.png
diff --git a/website/public/swift.png → docs/images/swift.png b/website/public/swift.png → docs/images/swift.png
diff --git a/website/public/thumbnail.png → docs/images/thumbnail.png b/website/public/thumbnail.png → docs/images/thumbnail.png
diff --git a/website/docs/installation.mdx → docs/installation.mdx b/website/docs/installation.mdx → docs/installation.mdx
diff --git a/website/docs/README.mdx → docs/introduction.mdx b/website/docs/README.mdx → docs/introduction.mdx
@@ -1,5 +1,5 @@
 ---
-title: Getting Started
+title: Introduction
 ---
 
 ## Overview

diff --git a/docs/logo/swift.svg b/docs/logo/swift.svg
diff --git a/docs/mint.json b/docs/mint.json
@@ -0,0 +1,49 @@
+{
+  "$schema": "https://mintlify.com/schema.json",
+  "name": "SwiftGraphQL",
+  "logo": {
+    "dark": "/logo/swift.svg",
+    "light": "/logo/swift.svg"
+  },
+  "favicon": "/favicon.svg",
+  "colors": {
+    "primary": "#F25C40",
+    "light": "#F25C40",
+    "dark": "#F25C40",
+    "anchors": {
+      "from": "#F25C40",
+      "to": "#F25C40"
+    }
+  },
+  "topbarLinks": [],
+  "topbarCtaButton": {
+    "name": "Get Started",
+    "url": "installation"
+  },
+  "tabs": [],
+  "anchors": [
+    {
+      "name": "Documentation",
+      "icon": "book-open-cover",
+      "url": "introduction"
+    }
+  ],
+  "navigation": [
+    {
+      "group": "Get Started",
+      "pages": ["introduction", "why", "installation", "network", "querying", "subscriptions", "errors", "faq"]
+    },
+    {
+      "group": "Essentials",
+      "pages": ["guides/auth", "guides/uploads", "guides/filestructure"]
+    },
+    {
+      "group": "Advanced",
+      "pages": ["advanced/scalars", "advanced/cache", "advanced/exchanges", "advanced/how", "advanced/selection"]
+    }
+  ],
+  "footerSocials": {
+    "twitter": "https://twitter.com/maticzav",
+    "github": "https://github.com/maticzav"
+  }
+}
diff --git a/website/docs/network.mdx → docs/network.mdx b/website/docs/network.mdx → docs/network.mdx
diff --git a/website/docs/querying.mdx → docs/querying.mdx b/website/docs/querying.mdx → docs/querying.mdx
diff --git a/website/docs/subscriptions.mdx → docs/subscriptions.mdx b/website/docs/subscriptions.mdx → docs/subscriptions.mdx
diff --git a/website/docs/why.mdx → docs/why.mdx b/website/docs/why.mdx → docs/why.mdx
diff --git a/package.json b/package.json
@@ -8,6 +8,7 @@
     "@types/prettier": "^2.3.2",
     "husky": "^4.3.8",
     "marked": "^2.1.3",
+    "mintlify": "^4.0.104",
     "prettier": "^2.3.2",
     "ts-node": "^10.2.1",
     "ts-node-dev": "^1.1.8",