From 71e28b011cd5a01e11ae890eab3df5205efdfd6f Mon Sep 17 00:00:00 2001 From: solidsnakedev Date: Thu, 31 Jul 2025 13:17:20 -0600 Subject: [PATCH] fix: prettify quickstart codeblock and improve CI build - Add validation script to prettify codeblocks with better comments - Remove prebuild from CI - run validation locally before commit - Keep fetch-depth: 0 to fix nextra shallow clone warning --- .github/workflows/docs.yml | 3 +++ docs/package.json | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bdf6b996..c87639a6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -67,6 +67,9 @@ jobs: - run: pnpm turbo run docgen --filter=@evolution-sdk/evolution + # Copy the generated API docs to the docs project + - run: pnpm --filter=@evolution-sdk/docs run copy-evolution-docs + # Build the docs with Next.js static export (output: export in next.config.js) - run: pnpm --filter=@evolution-sdk/docs run build diff --git a/docs/package.json b/docs/package.json index 93bf76e9..13c16484 100644 --- a/docs/package.json +++ b/docs/package.json @@ -10,7 +10,9 @@ "export": "next build", "copy-evolution-docs": "node scripts/copy-evolution-docs.mjs", "validate-codeblocks": "node scripts/validate-and-update-codeblocks.mjs", - "prebuild": "pnpm run copy-evolution-docs && pnpm run validate-codeblocks" + "validate-codeblocks-safe": "node scripts/validate-and-update-codeblocks.mjs", + "prebuild": "pnpm run copy-evolution-docs && (pnpm run validate-codeblocks-safe || true)", + "update-docs": "pnpm run copy-evolution-docs && pnpm run validate-codeblocks" }, "dependencies": { "next": "^14.0.0", @@ -23,6 +25,7 @@ "@types/node": "^20.0.0", "@types/react": "^18.2.0", "@types/react-dom": "^18.2.0", + "tsx": "^4.7.0", "typescript": "^5.0.0" } }