From b048f2d9b9ffd292793e97d11852fa768374959f Mon Sep 17 00:00:00 2001 From: Liren Tu Date: Tue, 27 Jan 2026 12:04:00 -0800 Subject: [PATCH 1/5] Update readme --- README.md | 24 +++--------------------- 1 file changed, 3 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e1a4c48..2f99261 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,5 @@ # Liquid Documentation -## Docs - -| Doc | Directory | Sidebar | -| --- | --- | --- | -| LFM | [lfm](./lfm) | [`sidebarsLfm.ts`](./sidebarsLfm.ts) | -| LEAP | [leap](./leap) | [`sidebarsLeap.ts`](./sidebarsLeap.ts) | -| Examples | [examples](./examples) | [`sidebarsExamples.ts`](./sidebarsExamples.ts) | - ## Local Development ```sh @@ -26,19 +18,9 @@ npm run serve The `npm run serve` script does not support hot loading. -## Search - -Search is enabled by Algolia: - -- Algolia crawler runs regularly on certain days within a week configured in the [crawler](https://dashboard.algolia.com/apps/NU3OWTAZ9V/crawler/crawlers). -- It also runs periodically through the [`algolia-index.yaml`](./.github/workflows/algolia-index.yaml) GitHub action, when there are changes in the `production` branch. - ## Link check -There are two link checks in this repo: - -- Docusaurus will throw error for any broken as configured by `onBrokenLinks` in [`docusaurus.config.ts`](./docusaurus.config.ts). If the broken build is annoying for preview, change it to `warn`. -- The [`check.yaml`](./.github/workflows/check.yaml) workflow has a `check-link` job that examine markdown links. Customize the config in [`link-check.json`](./link-check.json). If a link cannot be accessed (e.g. Github private repo), add the URL pattern to the `ignorePatterns` array. +The [`check.yaml`](./.github/workflows/check.yaml) workflow has a `check-link` job that examine markdown links. Customize the config in [`link-check.json`](./link-check.json). If a link cannot be accessed (e.g. Github private repo), add the URL pattern to the `ignorePatterns` array. ## Deployment @@ -46,8 +28,8 @@ The deployment is automated through Vercel. | Branch | Domain | | ------------ | ------------------------------- | -| `main` | https://docs-staging.liquid.ai/ | -| `production` | https://docs.liquid.ai/ | +| `production` | https://docs.liquid.ai | +| `main` | https://liquidai-main.mintlify.app | To promote the `main` branch to `production`, run the [`deploy-main.yaml`](https://github.com/Liquid4All/docs/actions/workflows/deploy-main.yaml) GitHub action, which will automatically fast-forward the `production` branch to match `main`. From 2f5cae8d5a2833cc6c474509367f780d298ff32b Mon Sep 17 00:00:00 2001 From: Liren Tu Date: Tue, 27 Jan 2026 12:04:11 -0800 Subject: [PATCH 2/5] Remove algolia --- .github/workflows/algolia-index.yaml | 52 ---------------------------- 1 file changed, 52 deletions(-) delete mode 100644 .github/workflows/algolia-index.yaml diff --git a/.github/workflows/algolia-index.yaml b/.github/workflows/algolia-index.yaml deleted file mode 100644 index 608c376..0000000 --- a/.github/workflows/algolia-index.yaml +++ /dev/null @@ -1,52 +0,0 @@ -name: Algolia Indexing - -on: - workflow_dispatch: - # This workflow cannot be chained from the deploy-main.yaml workflow, - # because it will trigger the indexing immediately after the production branch - # is updated, which is before the Vercel production deployment is finished. - # So the current approach is to run this workflow regularly, and trigger - # indexing if there is any recent commits in the production branch. - schedule: - - cron: "3 */6 * * *" - -jobs: - trigger-algolia-crawl: - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - ref: production - fetch-depth: 0 - - - name: Check for recent commits - if: github.event_name == 'schedule' - id: check_commits - run: | - # Get timestamp from 6 hours ago - six_hours_ago=$(date -u -d '6 hours ago' +%s) - - # Get the timestamp of the last commit - last_commit_time=$(git log -1 --format=%ct) - - # Compare timestamps - if [ $last_commit_time -gt $six_hours_ago ]; then - echo "has_recent_commits=true" >> $GITHUB_OUTPUT - echo "Found commits in the last 6 hours" - else - echo "has_recent_commits=false" >> $GITHUB_OUTPUT - echo "No commits in the last 6 hours" - fi - - - name: Trigger Algolia crawler - if: github.event_name == 'workflow_dispatch' || steps.check_commits.outputs.has_recent_commits == 'true' - uses: cssnr/algolia-crawler-action@v2 - with: - # Find crawler ID by clicking into the crawler this page: - # https://dashboard.algolia.com/apps/NU3OWTAZ9V/crawler/crawlers - crawler_id: ${{ secrets.ALGOLIA_CRAWLER_ID }} - # Get crawler user ID and API key from this page: - # https://dashboard.algolia.com/apps/NU3OWTAZ9V/crawler/settings - crawler_user_id: ${{ secrets.ALGOLIA_CRAWLER_USER_ID }} - crawler_api_key: ${{ secrets.ALGOLIA_CRAWLER_API_KEY }} From 1d7fc551eac3d638dad0660d6c434bc7c68c0cd5 Mon Sep 17 00:00:00 2001 From: Liren Tu Date: Tue, 27 Jan 2026 13:01:04 -0800 Subject: [PATCH 3/5] Deploy to preview instead of production --- .github/workflows/deploy-preview.yaml | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy-preview.yaml b/.github/workflows/deploy-preview.yaml index a6ebc33..e924099 100644 --- a/.github/workflows/deploy-preview.yaml +++ b/.github/workflows/deploy-preview.yaml @@ -24,6 +24,14 @@ jobs: steps: - name: Trigger mintlify preview deployment run: | + BRANCH_NAME="${{ github.head_ref || github.ref_name }}" + SUBDOMAIN=liquidai-$(echo "$BRANCH_NAME" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9-]/-/g' | sed 's/^-+\|-+$//g') + curl --request POST \ - --url https://api.mintlify.com/v1/project/update/${{ secrets.MINTLIFY_PROJECT_ID }} \ - --header 'Authorization: Bearer ${{ secrets.MINTLIFY_API_TOKEN }}' + --url https://api.mintlify.com/v1/deployment \ + --header 'Authorization: Bearer ${{ secrets.MINTLIFY_API_TOKEN }}' \ + --header 'Content-Type: application/json' \ + --data "{ + \"subdomain\": \"${SUBDOMAIN}\", + \"gitBranch\": \"${BRANCH_NAME}\" + }" From fbc8cf1de83ff05b0c1b60d61b4539d6902ad071 Mon Sep 17 00:00:00 2001 From: Liren Tu Date: Tue, 27 Jan 2026 13:55:15 -0800 Subject: [PATCH 4/5] Remove preview workflow --- .github/workflows/deploy-preview.yaml | 37 --------------------------- 1 file changed, 37 deletions(-) delete mode 100644 .github/workflows/deploy-preview.yaml diff --git a/.github/workflows/deploy-preview.yaml b/.github/workflows/deploy-preview.yaml deleted file mode 100644 index e924099..0000000 --- a/.github/workflows/deploy-preview.yaml +++ /dev/null @@ -1,37 +0,0 @@ -name: Preview - -on: - push: - branches: - - main - pull_request: - branches: - - main - workflow_dispatch: - -concurrency: - group: ${{ github.workflow }}-${{ github.ref || github.run_id }} - cancel-in-progress: false - -env: - NEXT_TELEMETRY_DISABLED: 1 - HUSKY: 0 - CI: 1 - -jobs: - deploy-preview: - runs-on: ubuntu-latest - steps: - - name: Trigger mintlify preview deployment - run: | - BRANCH_NAME="${{ github.head_ref || github.ref_name }}" - SUBDOMAIN=liquidai-$(echo "$BRANCH_NAME" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9-]/-/g' | sed 's/^-+\|-+$//g') - - curl --request POST \ - --url https://api.mintlify.com/v1/deployment \ - --header 'Authorization: Bearer ${{ secrets.MINTLIFY_API_TOKEN }}' \ - --header 'Content-Type: application/json' \ - --data "{ - \"subdomain\": \"${SUBDOMAIN}\", - \"gitBranch\": \"${BRANCH_NAME}\" - }" From be46ab63bf56413f68e949a2623aeaeced4540bf Mon Sep 17 00:00:00 2001 From: Liren Tu Date: Tue, 27 Jan 2026 13:55:59 -0800 Subject: [PATCH 5/5] Update readme --- README.md | 29 ----------------------------- 1 file changed, 29 deletions(-) diff --git a/README.md b/README.md index 2f99261..e287eba 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,9 @@ # Liquid Documentation -## Local Development - -```sh -npm install -npm run dev -``` - -The local server will be available at `http://localhost:3000`. - -To test the build: - -```sh -npm run build -npm run serve -``` - -The `npm run serve` script does not support hot loading. - ## Link check The [`check.yaml`](./.github/workflows/check.yaml) workflow has a `check-link` job that examine markdown links. Customize the config in [`link-check.json`](./link-check.json). If a link cannot be accessed (e.g. Github private repo), add the URL pattern to the `ignorePatterns` array. -## Deployment - -The deployment is automated through Vercel. - -| Branch | Domain | -| ------------ | ------------------------------- | -| `production` | https://docs.liquid.ai | -| `main` | https://liquidai-main.mintlify.app | - -To promote the `main` branch to `production`, run the [`deploy-main.yaml`](https://github.com/Liquid4All/docs/actions/workflows/deploy-main.yaml) GitHub action, which will automatically fast-forward the `production` branch to match `main`. - ## LICENSE [Attribution-ShareAlike 4.0 International](./LICENSE)