chore: Add docs to monorepo

superstreamerapp · Oct 19, 2024 · 521fe92 · 521fe92
1 parent c59eca6
commit 521fe92
Show file tree

Hide file tree

Showing 15 changed files with 705 additions and 173 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -2,7 +2,7 @@ name: Deploy Docs to GitHub Pages
 
 on:
   push:
-    branches: [main]
+    branches: [main, docs]
   workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -28,20 +28,23 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+      - uses: pnpm/action-setup@v3
       - name: Setup node
         uses: actions/setup-node@v4
         with:
           node-version: 20
+          cache: pnpm
       - name: Setup Pages
         uses: actions/configure-pages@v4
       - name: Install dependencies
-        run: npm ci
+        run: pnpm --filter "docs" install
       - name: Build with VitePress
-        run: npm run build
+        run: pnpm --filter "docs" build
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: ./docs/.vitepress/dist
+          path: docs/.vitepress/dist
+
   deploy:
     environment:
       name: github-pages

diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -5,8 +5,7 @@
     "dev": "vitepress dev",
     "build": "vitepress build"
   },
-  "dependencies": {
-    "vitepress": "^1.3.2",
-    "vue": "^3.5.12"
+  "devDependencies": {
+    "vitepress": "^1.3.2"
   }
 }
diff --git a/packages/api/src/env.ts b/packages/api/src/env.ts
@@ -1,4 +1,4 @@
-import { parseEnv } from "shared";
+import { parseEnv } from "shared/env";
 
 export const env = parseEnv((t) => ({
   // process

diff --git a/packages/api/src/index.ts b/packages/api/src/index.ts
@@ -6,8 +6,8 @@ import {
   LangCodeSchema,
   VideoCodecSchema,
   AudioCodecSchema,
-  scalarCustomCss,
-} from "shared";
+} from "shared/typebox";
+import { customCss } from "shared/scalar";
 import { env } from "./env";
 import { getJob, getJobs, getJobLogs } from "./jobs";
 import { getStorageFolder, getStorageFile } from "./s3";
@@ -30,7 +30,7 @@ const app = new Elysia()
       },
       scalarConfig: {
         hideDownloadButton: true,
-        customCss: scalarCustomCss,
+        customCss,
       },
     }),
   )

diff --git a/packages/artisan/src/consumer/env.ts b/packages/artisan/src/consumer/env.ts
@@ -1,4 +1,4 @@
-import { parseEnv } from "shared";
+import { parseEnv } from "shared/env";
 
 export const env = parseEnv((t) => ({
   // config.env

diff --git a/packages/artisan/src/producer/env.ts b/packages/artisan/src/producer/env.ts
@@ -1,4 +1,4 @@
-import { parseEnv } from "shared";
+import { parseEnv } from "shared/env";
 
 export const env = parseEnv((t) => ({
   // config.env

diff --git a/packages/artisan/src/types.ts b/packages/artisan/src/types.ts
@@ -1,4 +1,4 @@
-import type { LangCode, VideoCodec, AudioCodec } from "shared";
+import type { LangCode, VideoCodec, AudioCodec } from "shared/typebox";
 
 export type Stream =
   | {

diff --git a/packages/dashboard/vite.config.ts b/packages/dashboard/vite.config.ts
@@ -2,7 +2,7 @@ import { defineConfig, Plugin } from "vite";
 import react from "@vitejs/plugin-react";
 import path from "path";
 import { fileURLToPath } from "url";
-import { parseEnv } from "shared";
+import { parseEnv } from "shared/env";
 
 // When we inject new PUBLIC_ variables, make sure to add them
 // in src/globals.d.ts too. All of these are optional because we

diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -3,7 +3,11 @@
   "private": true,
   "version": "1.0.0",
   "type": "module",
-  "main": "./src/index.ts",
+  "exports": {
+    "./env": "./src/env.ts",
+    "./scalar": "./src/scalar.ts",
+    "./typebox": "./src/typebox.ts"
+  },
   "scripts": {
     "lint": "eslint"
   },

diff --git a/packages/shared/src/scalar.ts b/packages/shared/src/scalar.ts
@@ -1,4 +1,4 @@
-export const scalarCustomCss = `
+export const customCss = `
   .scalar-container.z-overlay {
     padding-left: 16px;
     padding-right: 16px;

diff --git a/packages/stitcher/src/env.ts b/packages/stitcher/src/env.ts
@@ -1,4 +1,4 @@
-import { parseEnv } from "shared";
+import { parseEnv } from "shared/env";
 
 export const env = parseEnv((t) => ({
   // process

diff --git a/packages/stitcher/src/index.ts b/packages/stitcher/src/index.ts
@@ -1,7 +1,7 @@
 import { Elysia, t } from "elysia";
 import { cors } from "@elysiajs/cors";
 import { swagger } from "@elysiajs/swagger";
-import { scalarCustomCss } from "shared";
+import { customCss } from "shared/scalar";
 import { env } from "./env";
 import { createSession } from "./session";
 import { validateFilter } from "./filters";
@@ -26,7 +26,7 @@ const app = new Elysia()
       },
       scalarConfig: {
         hideDownloadButton: true,
-        customCss: scalarCustomCss,
+        customCss,
       },
     }),
   )