Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/docs-archive-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Docs Archive Vercel Deploy

on:
push:
branches:
- main
paths:
- "docs-archive/**"
- ".github/workflows/docs-archive-deploy.yml"
workflow_dispatch:

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 18
cache: npm
cache-dependency-path: docs-archive/package-lock.json

- name: Install dependencies
working-directory: docs-archive
run: npm ci

- name: Build Docusaurus site
working-directory: docs-archive
run: |
NODE_OPTIONS="--max-old-space-size=6144" \
DOCUSAURUS_SSR_CONCURRENCY=1 \
npm run build

- name: Deploy to Vercel (prebuilt)
working-directory: docs-archive
run: |
npx vercel deploy --prebuilt --prod --yes \
--token=${{ secrets.VERCEL_TOKEN }} \
--org=${{ secrets.VERCEL_ORG_ID }} \
--project=${{ secrets.VERCEL_PROJECT_ID }}
17 changes: 16 additions & 1 deletion docs-archive/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,28 @@ npm install
```

### 2. Start the Server
Because this archive contains over a dozen full versions of the documentation, it requires a higher memory heap to compile. You must set the `NODE_OPTIONS` environment variable before starting or building.
Because this archive contains over a dozen full versions of the documentation, it requires a higher memory heap to compile. You may need to set the `NODE_OPTIONS` environment variable before starting or building.
```bash
export NODE_OPTIONS=--max-old-space-size=8192
npm start
```

This command starts a local development server at `http://localhost:3000`.

### 3. Build the Site
For local builds, you may need increased memory:
```bash
export NODE_OPTIONS=--max-old-space-size=8192
npm run build
```

Alternatively, you can use the helper script (recommended):
```bash
npm run build:high-mem
```

> On lower memory settings (4GB–6GB), builds may fail due to the size of the archive.


#### ⚠️ Maintenance Note
Do not upgrade this archive to Docusaurus v3. These legacy versions contain historical MDX 1 syntax. Upgrading to v3 (MDX 2) will cause fatal parsing errors across thousands of older files. Treat this directory as a read-only time capsule unless fixing critical broken links or 404s.
3 changes: 2 additions & 1 deletion docs-archive/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"scripts": {
"docusaurus": "docusaurus",
"start": "NODE_OPTIONS='--max-old-space-size=8192' docusaurus start",
"build": "NODE_OPTIONS='--max-old-space-size=8192' docusaurus build",
"build": "docusaurus build",
"build:high-mem": "NODE_OPTIONS='--max-old-space-size=8192' docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
Expand Down
Loading