chore: move Jan Docs back into Jan Repo (janhq#3790)

Co-authored-by: Hien To <[email protected]>

.github/workflows/clean-cloudflare-page-preview-url-and-r2.yml

@@ -0,0 +1,52 @@
+name: "Clean old cloudflare pages preview urls and nightly build"
+on:
+  schedule:
+    - cron: "0 0 * * *" # every day at 00:00
+  workflow_dispatch:
+
+jobs:
+  clean-cloudflare-pages-preview-urls:
+    strategy:
+      matrix:
+        project: ["nitro", "docs"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: install requests
+        run: |
+          python3 -m pip install requests pytz tqdm
+      - name: Python Inline script
+        uses: jannekem/run-python-script-action@v1
+        with: 
+          script: |
+            import requests
+            from datetime import datetime, UTC
+            from pytz import timezone
+            from tqdm import tqdm
+            
+            # Configuration
+            endpoint = "https://api.cloudflare.com/client/v4/accounts/${{ secrets.CLOUDFLARE_ACCOUNT_ID }}/pages/projects/${{ matrix.project }}/deployments"
+            expiration_days = 3
+            headers = {
+                "Content-Type": "application/json;charset=UTF-8",
+                "Authorization": "Bearer ${{ secrets.CLOUDFLARE_API_TOKEN }}"
+            }
+            utc_tz = timezone('UTC')
+
+            # Fetch the list of deployments
+            response = requests.get(endpoint, headers=headers)
+            deployments = response.json()
+
+            for deployment in tqdm(deployments['result']):
+                # Calculate the age of the deployment
+                created_on = datetime.strptime(deployment['created_on'], "%Y-%m-%dT%H:%M:%S.%fZ").replace(tzinfo=utc_tz)
+                if (datetime.now(UTC) - created_on).days > expiration_days:
+                    # Delete the deployment
+                    delete_response = requests.delete(f"{endpoint}/{deployment['id']}", headers=headers)
+                    if delete_response.status_code == 200:
+                        print(f"Deleted deployment: {deployment['id']}")
+                    else:
+                        print(f"Failed to delete deployment: {deployment['id']}")
+

.github/workflows/jan-docs-new-release.yaml

@@ -0,0 +1,63 @@
+name: Deploy Docs on new release
+
+on:
+  release:
+    types:
+      - published
+      - edited
+      - released
+
+jobs:
+  deploy:
+    name: Deploy to CloudFlare Pages
+    env:
+      CLOUDFLARE_PROJECT_NAME: docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      deployments: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: dev
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install jq      
+        uses: dcarbone/[email protected]
+
+      - name: Fill env vars
+        working-directory: docs
+        run: |
+          env_example_file=".env.example"
+          touch .env
+          while IFS= read -r line || [[ -n "$line" ]]; do
+            if [[ "$line" == *"="* ]]; then
+              var_name=$(echo $line | cut -d '=' -f 1)
+              echo $var_name
+              var_value="$(jq -r --arg key "$var_name" '.[$key]' <<< "$SECRETS")"
+              echo "$var_name=$var_value" >> .env
+            fi
+          done < "$env_example_file"
+        env:
+          SECRETS: '${{ toJson(secrets) }}'
+
+      - name: Install dependencies
+        working-directory: docs
+        run: yarn install
+      - name: Build website
+        working-directory: docs
+        run: export NODE_ENV=production && yarn build && cp _redirects out/_redirects
+
+      - name: Publish to Cloudflare Pages Production
+        uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: ${{ env.CLOUDFLARE_PROJECT_NAME }}
+          directory: ./docs/out
+          branch: dev
+          # Optional: Enable this if you want to have GitHub Deployments triggered
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/jan-docs.yml

@@ -0,0 +1,82 @@
+name: Jan Docs
+
+on:
+  push:
+    branches:
+      - dev
+  pull_request:
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    name: Deploy to CloudFlare Pages
+    env:
+      CLOUDFLARE_PROJECT_NAME: docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      deployments: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install jq      
+        uses: dcarbone/[email protected]
+
+      - name: Fill env vars
+        working-directory: docs
+        run: |
+          env_example_file=".env.example"
+          touch .env
+          while IFS= read -r line || [[ -n "$line" ]]; do
+            if [[ "$line" == *"="* ]]; then
+              var_name=$(echo $line | cut -d '=' -f 1)
+              echo $var_name
+              var_value="$(jq -r --arg key "$var_name" '.[$key]' <<< "$SECRETS")"
+              echo "$var_name=$var_value" >> .env
+            fi
+          done < "$env_example_file"
+        env:
+          SECRETS: '${{ toJson(secrets) }}'
+
+      - name: Install dependencies
+        working-directory: docs
+        run: yarn install
+      - name: Build website
+        working-directory: docs
+        run: export NODE_ENV=production && yarn build && cp _redirects out/_redirects
+
+      - name: Publish to Cloudflare Pages PR Preview and Staging
+        if: github.event_name == 'pull_request'
+        uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: ${{ env.CLOUDFLARE_PROJECT_NAME }}
+          directory: ./docs/out
+          # Optional: Enable this if you want to have GitHub Deployments triggered
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+        id: deployCloudflarePages
+
+      - uses: mshick/add-pr-comment@v2
+        if: github.event_name == 'pull_request'
+        with:
+          message: |
+              Preview URL: ${{ steps.deployCloudflarePages.outputs.url }}
+
+      - name: Publish to Cloudflare Pages Production
+        if: (github.event_name == 'push' && github.ref == 'refs/heads/dev') || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/dev')
+        uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: ${{ env.CLOUDFLARE_PROJECT_NAME }}
+          directory: ./docs/out
+          branch: dev
+          # Optional: Enable this if you want to have GitHub Deployments triggered
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

docs/.env.example

@@ -0,0 +1 @@
+GTM_ID=xxxx

docs/.eslintrc.json

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

docs/.gitignore

@@ -0,0 +1,37 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# 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
+.env
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

docs/.prettierignore

@@ -0,0 +1,5 @@
+.next/
+node_modules/
+dist/
+*.mdx
+*.hbs

docs/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "quoteProps": "consistent",
+  "trailingComma": "es5",
+  "endOfLine": "auto"
+}

docs/README.md

@@ -0,0 +1,66 @@
+# Website & Docs
+
+This website is built using [Nextra](https://nextra.site/), a modern static website generator.
+
+### Information Architecture
+
+We try to **keep routes consistent** to maintain SEO.
+
+- **`/guides/`**: Guides on how to use the Jan application. For end users who are directly using Jan.
+
+- **`/developer/`**: Developer docs on how to extend Jan. These pages are about what people can build with our software.
+
+- **`/api-reference/`**: Reference documentation for the Jan API server, written in Swagger/OpenAPI format.
+
+- **`/changelog/`**: A list of changes made to the Jan application with each release.
+
+- **`/blog/`**: A blog for the Jan application.
+
+## How to Contribute
+
+Refer to the [Contributing Guide](https://github.com/janhq/jan/blob/main/CONTRIBUTING.md) for more comprehensive information on how to contribute to the Jan project.
+
+### Pre-requisites and Installation
+
+- [Node.js](https://nodejs.org/en/) (version 20.0.0 or higher)
+- [yarn](https://yarnpkg.com/) (version 1.22.0 or higher)
+
+#### Installation
+
+```bash
+cd jan/docs
+yarn install
+yarn dev
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+#### Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+
+### Preview URL, Pre-release and Publishing Documentation
+
+- When a pull request is created, the preview URL will be automatically commented on the pull request.
+
+- The documentation will then be published to [https://jan.ai/](https://jan.ai/) when the pull request is merged to `main`.