chore: move docs website to main repo

.github/workflows/deploy-docs.yaml

@@ -0,0 +1,30 @@
+name: Deploy Docs and Trigger Main Website Build
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+      - name: Install dependencies
+        run: yarn install
+      - name: Apply all pending migrations to the database
+        run: npx prisma migrate deploy
+        env:
+          POSTGRES_PRISMA_URL: ${{ secrets.POSTGRES_PRISMA_URL }}
+          POSTGRES_URL_NON_POOLING: ${{ secrets.POSTGRES_URL_NON_POOLING }}
+      # Trigger the deployment of the main website for guide updates
+      - name: Trigger main website build
+        run: |
+          curl -X POST ${{ secrets.MAIN_WEBSITE_DEPLOY_URL }}

.github/workflows/test-docs.yaml

@@ -0,0 +1,123 @@
+name: Test Docs
+
+on:
+  pull_request:
+    paths:
+      - "docs/**"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    env:
+      NODE_OPTIONS: --max-old-space-size=4096
+      NEXT_PUBLIC_VERCEL_URL: nitric.io
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install dependencies
+        uses: cypress-io/github-action@v6
+        with:
+          runTests: false
+          install-command: yarn --frozen-lockfile
+          working-directory: docs
+      - name: Run format linting
+        run: yarn format:check
+      - name: Run spellcheck test
+        run: yarn test:spellcheck
+
+  test-broken-links:
+    runs-on: ubuntu-latest
+    needs: [tests]
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Cypress tests 🧪
+        uses: cypress-io/github-action@v6
+        with:
+          headless: true
+          config: video=false
+          browser: chrome
+          spec: cypress/e2e/broken-links.cy.ts
+          build: yarn cypress:build
+          start: yarn start
+          wait-on: "http://localhost:3000"
+          working-directory: docs
+        env:
+          NEXT_PUBLIC_GITHUB_BRANCH: ${{ github.head_ref || github.ref_name }}
+      - name: Upload screenshots
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: cypress-screenshots-broken-links
+          path: docs/cypress/screenshots
+
+  test-a11y:
+    runs-on: ubuntu-latest
+    needs: [tests]
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Cypress tests 🧪
+        uses: cypress-io/github-action@v6
+        with:
+          headless: true
+          config: video=false
+          browser: chrome
+          spec: cypress/e2e/a11y.cy.ts
+          build: yarn cypress:build
+          start: yarn start
+          wait-on: "http://localhost:3000"
+          working-directory: docs
+        env:
+          NEXT_PUBLIC_GITHUB_BRANCH: ${{ github.head_ref || github.ref_name }}
+      - name: Upload screenshots
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: cypress-screenshots-a11y
+          path: docs/cypress/screenshots
+
+  test-seo:
+    runs-on: ubuntu-latest
+    needs: [tests]
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Cypress tests 🧪
+        uses: cypress-io/github-action@v6
+        with:
+          headless: true
+          config: video=false
+          browser: chrome
+          spec: cypress/e2e/seo.cy.ts
+          build: yarn cypress:build
+          start: yarn start
+          wait-on: "http://localhost:3000"
+          working-directory: docs
+        env:
+          NEXT_PUBLIC_GITHUB_BRANCH: ${{ github.head_ref || github.ref_name }}
+      - name: Upload screenshots
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: cypress-screenshots-seo
+          path: docs/cypress/screenshots

.github/workflows/test.yaml

@@ -4,7 +4,11 @@ on:
   push:
     branches:
       - main
+    paths-ignore:
+      - "docs/**"
   pull_request:
+    paths-ignore:
+      - "docs/**"
 
 jobs:
   build:

docs/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

docs/.gitignore

@@ -0,0 +1,39 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+.contentlayer
+
+old

docs/.husky/pre-commit

@@ -0,0 +1 @@
+yarn lint-staged

docs/.prettierignore

@@ -0,0 +1,22 @@
+# Ignore build artifacts
+dist/
+build/
+out/
+
+# Exclude third-party code
+node_modules/
+vendor/
+
+# Exclude configuration files
+.eslintrc
+.eslintignore
+
+# Skip binary files
+*.png
+*.jpg
+*.gif
+
+# Exclude version control directories
+.git/
+.svn/
+.hg/

docs/.puppeteerrc.cjs

@@ -0,0 +1,19 @@
+const isCI = !!process.env.VERCEL_ENV
+
+if (!isCI) {
+  // just use the default configuration on non vercel CI environments
+  return {}
+}
+
+/**
+ * @type {import("puppeteer").Configuration}
+ */
+module.exports = {
+  cacheDirectory: '/vercel/.cache/puppeteer',
+  executablePath:
+    '/vercel/.cache/puppeteer/chrome/linux-131.0.6778.204/chrome-linux64/chrome',
+  chrome: {
+    skipDownload: true,
+  },
+  args: ['--no-sandbox', '--disable-setuid-sandbox', '--disable-dev-shm-usage'],
+}

docs/.spellcheckerrc.yml

@@ -0,0 +1,15 @@
+files:
+  - 'docs/**/*.{md,mdx}'
+dictionaries:
+  - dictionary.txt
+quiet: true
+language: en-US
+frontmatter-keys:
+  - description
+  - title_seo
+plugins:
+  - spell
+  - syntax-urls
+  - syntax-mentions
+  - repeated-words
+  - frontmatter

docs/README.md

@@ -0,0 +1,11 @@
+<p align="center"><a href="https://nitric.io" target="_blank"><img src="https://raw.githubusercontent.com/nitrictech/nitric/main/docs/assets/nitric-logo.svg" height="120"></a></p>
+
+## Nitric documentation
+
+Documentation for the [Nitric framework](https://github.com/nitrictech/nitric).
+
+Updates to the documentation will be included in the Nitric doc website located [here](https://nitric.io/docs).
+
+## Generated CLI Command Docs
+
+Output for the CLI commands are automatically generated into `/src/assets` via the [collect-assets.js script](./scripts/collect-assets.js) and can be referenced in the mdx pages as seen [here](./docs/reference/cli.mdx).

docs/chrome-dependencies.txt

@@ -0,0 +1,17 @@
+mesa-libgbm
+nss
+nspr
+at-spi2-atk
+cups-libs
+libdrm
+libXcomposite
+libXdamage
+libXext
+libXrandr
+libgbm
+libxcb
+alsa-lib
+atk
+gtk3
+pango
+libxkbcommon

docs/components.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": true,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.ts",
+    "css": "src/styles/tailwind.css",
+    "baseColor": "zinc",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
+  }
+}