diff --git a/.changeset/config.json b/.changeset/config.json index 65c3a86ebf..26d3ac44aa 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -22,7 +22,6 @@ "baseBranch": "stable", "updateInternalDependencies": "patch", "ignore": [ - "docs", "nextjs-turbopack", "nextjs-webpack", "workflow-sdk-compiler-playground", diff --git a/.github/workflows/docs-checks.yml b/.github/workflows/docs-checks.yml index 3454e963d3..c85830dd96 100644 --- a/.github/workflows/docs-checks.yml +++ b/.github/workflows/docs-checks.yml @@ -1,3 +1,7 @@ +# The docs/ directory does not exist on the stable branch. +# Docs are deployed only from main. This workflow is kept as a +# no-op on stable so that any branch protection rules referencing +# these job names still pass. name: Docs Checks on: @@ -16,74 +20,14 @@ concurrency: jobs: docs-typecheck: name: Docs Code Samples + if: false runs-on: ubuntu-latest - timeout-minutes: 5 - env: - TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} - TURBO_TEAM: ${{ vars.TURBO_TEAM }} steps: - - name: Checkout Repo - uses: actions/checkout@v4 - - - name: Setup pnpm - uses: pnpm/action-setup@v3 - with: - version: 10.14.0 - - - name: Setup Node.js 22.x - uses: actions/setup-node@v4 - with: - node-version: 22.x - cache: "pnpm" - - - name: Install Dependencies - run: pnpm install --frozen-lockfile - - - name: Build packages - run: pnpm build - - - name: Type-check documentation code samples - run: pnpm test:docs + - run: true docs-preview-smoke: name: Docs Preview Smoke Checks + if: false runs-on: ubuntu-latest - timeout-minutes: 5 - env: - TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} - TURBO_TEAM: ${{ vars.TURBO_TEAM }} steps: - - name: Checkout Repo - uses: actions/checkout@v4 - - - name: Setup pnpm - uses: pnpm/action-setup@v3 - with: - version: 10.14.0 - - - name: Setup Node.js 22.x - uses: actions/setup-node@v4 - with: - node-version: 22.x - cache: "pnpm" - - - name: Install Dependencies - run: pnpm install --frozen-lockfile - - - name: Waiting for the Docs Vercel deployment - id: waitForDocsDeployment - uses: ./.github/actions/wait-for-vercel-project - with: - team-id: "team_nLlpyC6REAqxydlFKbrMDlud" - project-id: "prj_aLMkVj1S4Alk08AThC76nXgwbLEB" - vercel-token: ${{ secrets.VERCEL_DOCS_TOKEN }} - timeout: 1000 - check-interval: 15 - environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }} - - - name: Verify OpenGraph images and sitemap - run: pnpm --filter docs test:smoke - env: - DEPLOYMENT_URL: ${{ steps.waitForDocsDeployment.outputs.deployment-url }} - VERCEL_AUTOMATION_BYPASS_SECRET: ${{ secrets.VERCEL_AUTOMATION_BYPASS_SECRET }} - VERCEL_DOCS_TOKEN: ${{ secrets.VERCEL_DOCS_TOKEN }} + - run: true diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 2948e2d3d5..440c7d6f8d 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -36,33 +36,11 @@ jobs: exit 1 fi + # The docs/ directory does not exist on the stable branch. + # This job is kept as a no-op so branch protection rules still pass. docs-links: name: Docs Links + if: false runs-on: ubuntu-latest - env: - TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }} - TURBO_TEAM: ${{ vars.TURBO_TEAM }} steps: - - name: Checkout Repo - uses: actions/checkout@v4 - - - name: Setup pnpm - uses: pnpm/action-setup@v3 - with: - version: 10.14.0 - - - name: Setup Node.js 22.x - uses: actions/setup-node@v4 - with: - node-version: 22.x - cache: "pnpm" - - - name: Setup Bun - uses: oven-sh/setup-bun@v2 - - - name: Install Dependencies - run: pnpm install --frozen-lockfile - - - name: Validate docs links - run: bun ./scripts/lint.ts - working-directory: docs + - run: true diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 0805f529d5..0000000000 --- a/docs/.gitignore +++ /dev/null @@ -1,38 +0,0 @@ -# deps -/node_modules - -# generated content -.contentlayer -.content-collections -.source - -# test & build -/coverage -/.next/ -/out/ -/build -*.tsbuildinfo - -# misc -.DS_Store -*.pem -/.pnp -.pnp.js -npm-debug.log* -yarn-debug.log* -yarn-error.log* - -# others -.env*.local -.vercel - -# typescript -*.tsbuildinfo -next-env.d.ts - -# pagefind -_pagefind/ - -# tarballs -*.tgz -.env*.local diff --git a/docs/LICENSE.md b/docs/LICENSE.md deleted file mode 120000 index 7eabdb1c27..0000000000 --- a/docs/LICENSE.md +++ /dev/null @@ -1 +0,0 @@ -../LICENSE.md \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index d68bb3497c..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Workflow SDK Docs - -Check out the docs [here](https://useworkflow.dev/) diff --git a/docs/app/[lang]/(home)/components/code-block.tsx b/docs/app/[lang]/(home)/components/code-block.tsx deleted file mode 100644 index 17c0123c96..0000000000 --- a/docs/app/[lang]/(home)/components/code-block.tsx +++ /dev/null @@ -1,32 +0,0 @@ -import { codeToHtml } from 'shiki'; -import { cn } from '@/lib/utils'; - -type CodeBlockProps = { - code: string; - lang: string; - codeblock?: { - className?: string; - }; -}; - -export const CodeBlock = async ({ code, lang, codeblock }: CodeBlockProps) => { - const html = await codeToHtml(code, { - lang, - themes: { - light: 'github-light-default', - dark: 'github-dark-default', - }, - defaultColor: false, - }); - - return ( -
- ); -}; diff --git a/docs/app/[lang]/(home)/components/cta.tsx b/docs/app/[lang]/(home)/components/cta.tsx deleted file mode 100644 index 4275bad89b..0000000000 --- a/docs/app/[lang]/(home)/components/cta.tsx +++ /dev/null @@ -1,13 +0,0 @@ -import Link from 'next/link'; -import { Button } from '@/components/ui/button'; - -export const CTA = () => ( -{item.description}
-- - use workflow - {' '} - brings durability, reliability, and observability to async JavaScript. - Build apps and AI Agents that can suspend, resume, and maintain state - with ease. -
-
- npm i workflow
-
-
- - With a simple declarative API to define and use your workflows. -
-- Move from hand-rolled queues and custom retries to durable, resumable - code with simple directives. -
-- The same code runs locally on your laptop, in Docker, on Vercel or any - other cloud. Open source and portable by design. -
-- See Workflow SDK in action with one of our templates. -
-- {item.description} -
-
- {children}
-
- );
-}
-
-function InlineLink({ children }: { children: ReactNode }) {
- return {children};
-}
-
-function VerifiedBadge() {
- return (
-
- );
-}
-
-function TweetCard({ url, name, username, image, tweet }: Tweet) {
- return (
-
- - {tweet} -
- - ); -} - -export const TweetWall = () => ( -- Build reliable, long-running processes with automatic retries, state - persistence, and observability built in. -
-- Compare workflow execution performance across all World - implementations. Lower times are better. -
-- Average workflow execution time across different benchmark - scenarios. Times shown are mean values in milliseconds. -
-- No benchmark data is currently available. -
- )} -- The World abstraction allows workflows to run anywhere — locally, - on Vercel, or on any cloud. The runtime, queues, and persistence - are modular and entirely swappable. -
-- Production grade — zero configuration, high throughput, - infinitely-scalable, e2e encrypted, and integrated observability -
-- Self hosted — control your data and scaling while running - workflows inside your own infrastructure -
-- Lightweight solutions for sidecars or local development -
-- See how workflows compare across the different worlds deployed - on different providers. Lower execution time means faster - workflows. -
- -- For illustration purposes only -
-- To learn more about how worlds work or to create your own, check - the docs. -
-{description}
- )} -{tooltip}
-Used {count} sources
-
- Tip: You can open and close chat with{' '}
-
- {localPrompt.length} / 1000 -
-code]:grid [&>code]:min-w-max',
- className,
- props.className
- )}
- ref={ref}
- style={style}
- tabIndex={tabIndex}
- >
- {children}
-
- ),
- [children, style, tabIndex, className]
- );
-
- if (!title) {
- return (
- Thank you for your feedback!
-Used {sources.length} sources
-