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>
67 lines
1.8 KiB
TypeScript
67 lines
1.8 KiB
TypeScript
import type { Root } from 'fumadocs-core/page-tree';
|
|
import { getDocsTreeWithoutCookbook } from './cookbook-source';
|
|
import type { DocsVersion } from './versions';
|
|
import { PRE_RELEASE_VERSION } from './versions';
|
|
|
|
function rewriteUrl(
|
|
url: string | undefined,
|
|
prefix: string
|
|
): string | undefined {
|
|
if (!url || !prefix) return url;
|
|
// Only rewrite in-app docs links. External and cookbook links are left alone.
|
|
if (!url.startsWith('/docs')) return url;
|
|
return `${prefix}${url}`;
|
|
}
|
|
|
|
function rewriteNodeUrls(
|
|
nodes: Root['children'],
|
|
prefix: string
|
|
): Root['children'] {
|
|
return nodes.map((node) => {
|
|
if (node.type === 'page') {
|
|
return { ...node, url: rewriteUrl(node.url, prefix) };
|
|
}
|
|
if (node.type === 'folder') {
|
|
return {
|
|
...node,
|
|
children: rewriteNodeUrls(node.children, prefix),
|
|
...(node.index
|
|
? {
|
|
index: {
|
|
...node.index,
|
|
url: rewriteUrl(node.index.url, prefix),
|
|
},
|
|
}
|
|
: {}),
|
|
};
|
|
}
|
|
return node;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Build the sidebar tree for a given docs version.
|
|
*
|
|
* - v4 (latest): returns the v4 source tree (content/docs/v4) with cookbook
|
|
* nodes stripped. No filtering needed — v4 simply doesn't contain v5-only
|
|
* pages.
|
|
* - v5 (pre-release): returns the v5 source tree (content/docs/v5) with
|
|
* cookbook nodes stripped and URLs rewritten to the `/v5/docs/...` namespace
|
|
* so sidebar links stay inside the v5 view.
|
|
*/
|
|
export function getDocsTreeForVersion(
|
|
lang: string,
|
|
version: DocsVersion
|
|
): Root {
|
|
if (version.preRelease) {
|
|
const base = getDocsTreeWithoutCookbook(lang, 'v5');
|
|
return {
|
|
...base,
|
|
children: rewriteNodeUrls(base.children, version.prefix),
|
|
};
|
|
}
|
|
return getDocsTreeWithoutCookbook(lang, 'v4');
|
|
}
|
|
|
|
export { PRE_RELEASE_VERSION };
|