Add documentation setup

.github/workflows/validate-workflow.yml

@@ -1,6 +1,6 @@
 name: Validate
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   main:
@@ -64,4 +64,4 @@ jobs:
           fields: repo,message,commit,author,action,eventName,ref,workflow,job,took,pullRequest # selectable (default: repo,message)
         env:
           SLACK_WEBHOOK_URL: ${{ secrets.SLATIFY_SLACK_WEBHOOK_URL }} # required
-        if: always() # Pick up events even if the job fails or is canceled.
+        if: ${{ env.SLACK_WEBHOOK_URL != '' && always() }} # Pick up events even if the job fails or is canceled.

README.md

@@ -1,11 +1,12 @@
-# Venice
+---
+title: Venice
+description: Venice is a the fastest way to get financial data from Plaid into your Postgres database.
+---
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
-
 <p align="center">
   <img src="https://link.useVenice.com/logo" alt="Venice logo" width="250"> 
 </p>
 
-**Venice** is a the fastest way to get financial data from Plaid into your Postgres database.
 
 Zero to production in 5 minutes without a single line of code:
 
@@ -17,7 +18,9 @@ Zero to production in 5 minutes without a single line of code:
 
 **One click deploy with Vercel**
 
-[![Deploy with Vercel](https://vercel.com/button)](https://link.useVenice.com/deploy)
+<a href="https://link.useVenice.com/deploy" rel="nofollow">
+  <img src="https://vercel.com/button" alt="Deploy with Vercel">
+</a>
 
 <p>
   <a href="https://link.useVenice.com/demo-video" rel="nofollow">
@@ -33,17 +36,6 @@ Zero to production in 5 minutes without a single line of code:
   </a>
 </p>
 
-## Table of Contents
-
-- [Why We Exist](#why-we-exist)
-- [What We Built](#what-we-built)
-- [Architecture](#architecture)
-- [Getting Started](#getting-started)
-- [Environment Variables](#environment-variables)
-- [Local Development](#local-development)
-- [FAQs](#faqs)
-- [Contribute & Support](#contribute--support)
-
 ## Why we exist
 
 We built Venice after working on multiple fintech products. Despite the explosion of amazing fintech services like Plaid, setting up a stack still takes a ton of work. Writing integration code, UI to help user manage their connections, maintaining uptime, running data pipelines, and building the company proved to be a lot to handle. There are a ton of undifferentated plumbing here and we think we can build it once as a community and not have everyone re-invent the wheel. That way fintech developers can do what they do best — build fintech, not ETL pipelines!

apps/next/package.json

@@ -3,9 +3,9 @@
   "version": "0.0.0",
   "private": true,
   "scripts": {
-    "build": "run-s --silent build:*",
+    "build": "run-s build:*",
     "build:css": "pnpm run generate:css --minify",
-    "build:migration": "pnpm --dir ../../ migration up",
+    "build:migration": "if [ \"$VERCEL_ENV\" = production ]; then pnpm --dir ../../ migration up; else echo 'Skip non-production migration'; fi",
     "build:next": "next build",
     "dev": "run-p --silent dev:*",
     "dev:css": "pnpm run generate:css --watch",

mint.json

@@ -0,0 +1,43 @@
+{
+  "name": "Venice",
+  "logo": {
+    "light": "/docs/logo/light.png",
+    "dark": "/docs/logo/dark.png"
+  },
+  "favicon": "/docs/favicon.png",
+  "colors": {
+    "primary": "#424054",
+    "light": "#E9E8EC",
+    "dark": "#2B2B2F",
+    "ultraLight": "#F9F9F9",
+    "ultraDark": "#1C1F23"
+  },
+  "topbarCtaButton": {
+    "type": "github",
+    "url": "https://github.com/usevenice/venice"
+  },
+  "anchors": [
+    {
+      "name": "Slack",
+      "icon": "slack",
+      "url": "https://link.usevenice.com/slack"
+    },
+    {
+      "name": "Product Roadmap",
+      "icon": "map",
+      "url": "https://github.com/orgs/usevenice/projects/1"
+    }
+  ],
+  "navigation": [
+    {
+      "group": "Home",
+      "pages": ["README", "docs/next-steps"]
+    }
+  ],
+  "backgroundImage": "/docs/background.png",
+  "footerSocials": {
+    "github": "https://github.com/usevenice",
+    "slack": "https://link.usevenice.com/slack",
+    "twitter": "https://twitter.com/use_venice"
+  }
+}