mirror of
https://github.com/vercel/workflow.git
synced 2026-09-14 19:59:43 +08:00
ea16d04599
* docs: split v4/v5 content, fix version switcher end-to-end ## Content restructuring - Split `docs/content/docs/` into `docs/content/docs/v4/` and `docs/content/docs/v5/` so each version is a fully independent content tree with no shared-file coupling - v4 excludes the four pages that are v5-only (AbortController cancellation docs and the serializable-abort-controller internal page) - v5 retains all pages; `preRelease` frontmatter field removed (no longer needed now that each version is its own folder) - Removed `AbortController` / `AbortSignal` from v4 serialization page (section moved to v5 only) ## Fumadocs source - Added `v4docs` and `v5docs` as separate `defineDocs()` collections in `source.config.ts`; shared `docsSchema` (no more `preRelease` field) - `source.ts` exports both `source` (v4, `baseUrl: /docs`) and `v5Source` (v5, same base URL) ## Version routing - `version-source.ts` simplified: `filterPreReleaseFromNodes` and `isPreReleaseUrl` logic removed; v4 tree uses `source`, v5 tree uses `v5Source` + `rewriteNodeUrls` - v4 `page.tsx`: removed `preRelease` guard (v4Source has no such pages) - v5 `page.tsx`: uses `v5Source` for `getPage` / `generateStaticParams` / `generateMetadata`; `v5Link` wrapper rewrites `/docs/…` hrefs to `/v5/docs/…` so inline MDX links stay in the v5 context ## Versioned cookbook - Added `app/[lang]/v5/cookbook/` layout + page (mirrors v4 but uses `v5Source`, `rewriteCookbookUrlForVersion`, and `V5CookbookLink`) - `getCookbookTree` accepts a `versionPrefix` parameter; sidebar URLs are prefixed accordingly (`/v5/cookbook/…`) - `cookbook-tree.ts`: added `skipVersions?: string[]` per-recipe field for version-specific exclusions; `distributed-abort-controller` is marked `skipVersions: ['v5']` ## Version switcher — state & navigation - New `VersionProvider` context (`hooks/geistdocs/use-version.tsx`) backed by `localStorage`: URL is source of truth on versioned pages, `localStorage` carries the preference across non-versioned pages (cookbook overview, worlds, etc.) - `VersionSwitcher` uses `useVersion()` context instead of URL-only detection; now visible on all pages including cookbook - `DesktopMenu` and `MobileMenu` use `activeVersion` from context so the "Docs" and "Cookbook" navbar links resolve to the correct version prefix on every page - `buildVersionUrl` expanded to handle `/cookbook/…` paths alongside `/docs/…`; non-versioned routes (worlds, api) return unchanged - `switchVersion` does a `HEAD` probe before navigating; falls back to the versioned cookbook or docs home if the target page doesn't exist in that version (handles v4-only → v5 and v5-only → v4 cases) ## Cookbook content (v5) - Rewrote `agent-cancellation` recipe using a single `AbortController` pattern; removed Hard Cancellation vs Stop Signal two-approach comparison - Deleted `distributed-abort-controller` recipe from v5 (native `AbortController` serialization makes it unnecessary) - Removed references to distributed-abort-controller from `cookbook/index.mdx` and `common-patterns/timeouts.mdx` Co-authored-by: Cursor <cursoragent@cursor.com> * fix(docs): use abortSignal (not signal) in DurableAgent.stream() options Co-authored-by: Cursor <cursoragent@cursor.com> * fix(docs): update prepack scripts to use versioned content paths Content moved from docs/content/docs/ to docs/content/docs/v5/ on main (pre-release channel). Stable branch will use v4/ after backport. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
83 lines
2.7 KiB
TypeScript
83 lines
2.7 KiB
TypeScript
export type DocsVersionId = 'v4' | 'v5';
|
|
|
|
export interface DocsVersion {
|
|
id: DocsVersionId;
|
|
label: string;
|
|
subtitle: string;
|
|
prefix: string;
|
|
preRelease: boolean;
|
|
}
|
|
|
|
export const VERSIONS: DocsVersion[] = [
|
|
{
|
|
id: 'v5',
|
|
label: 'v5 (Pre-release)',
|
|
subtitle: 'Workflow 5.x',
|
|
prefix: '/v5',
|
|
preRelease: true,
|
|
},
|
|
{
|
|
id: 'v4',
|
|
label: 'v4 (Latest)',
|
|
subtitle: 'Workflow 4.x',
|
|
prefix: '',
|
|
preRelease: false,
|
|
},
|
|
];
|
|
|
|
export const LATEST_VERSION = VERSIONS.find((v) => !v.preRelease)!;
|
|
export const PRE_RELEASE_VERSION = VERSIONS.find((v) => v.preRelease)!;
|
|
|
|
/**
|
|
* Derive the active docs version from a pathname. Matches `/v5/...` (or
|
|
* `/<lang>/v5/...` once locale prefix is applied) against the pre-release
|
|
* prefix; everything else is v4.
|
|
*/
|
|
export function getVersionFromPathname(pathname: string): DocsVersion {
|
|
// The v5 segment sits either at the root (default locale hidden) or right
|
|
// after a locale segment — both cases are covered by checking positions
|
|
// 0 and 1.
|
|
const segments = pathname.split('/').filter(Boolean);
|
|
if (segments[0] === 'v5' || segments[1] === 'v5') {
|
|
return PRE_RELEASE_VERSION;
|
|
}
|
|
return LATEST_VERSION;
|
|
}
|
|
|
|
/**
|
|
* Build a URL for the same page under a different version. Preserves the
|
|
* trailing path after `/docs/` and any locale prefix.
|
|
*
|
|
* Only `/docs/...` paths are version-specific. All other routes (e.g.
|
|
* `/cookbook`, `/worlds`) are shared across versions and are returned
|
|
* unchanged — there is no `/v5/cookbook` to navigate to.
|
|
*
|
|
* `usePathname()` can return either `/docs/...` (default locale hidden by
|
|
* the i18n middleware) or `/<locale>/docs/...` (non-default locale shown).
|
|
* We detect the locale segment by checking whether segment 0 is a
|
|
* structural path token (`docs` or `v5`) rather than assuming position.
|
|
*/
|
|
export function buildVersionUrl(
|
|
pathname: string,
|
|
targetVersion: DocsVersion
|
|
): string {
|
|
// Worlds and other shared routes have no versioned equivalent — unchanged.
|
|
if (!pathname.includes('/docs') && !pathname.includes('/cookbook')) {
|
|
return pathname;
|
|
}
|
|
|
|
const segments = pathname.split('/').filter(Boolean);
|
|
// Structural segments are path tokens that are never locale prefixes.
|
|
const isStructural = (s: string | undefined) =>
|
|
s === 'docs' || s === 'v5' || s === 'cookbook';
|
|
const localeSegments =
|
|
segments[0] && !isStructural(segments[0]) ? segments.slice(0, 1) : [];
|
|
let rest = segments.slice(localeSegments.length);
|
|
if (rest[0] === 'v5') rest = rest.slice(1);
|
|
const prefixSegments = targetVersion.prefix
|
|
? [targetVersion.prefix.replace(/^\//, '')]
|
|
: [];
|
|
const joined = [...localeSegments, ...prefixSegments, ...rest].join('/');
|
|
return `/${joined}`.replace(/\/+$/, '') || '/';
|
|
}
|