mirror of
https://github.com/vercel/workflow.git
synced 2026-09-14 19:59:43 +08:00
Pranay Prakash
8a872529fe
* docs: make /worlds the canonical home for World docs The world pages (Local/Postgres/Vercel) and Building a World were duplicated inside the v4 and v5 docs trees while /worlds/[id] rendered the v4 copy — hiding v5-only content like multi-region and leaving two diverging sources of truth. - Move world docs to an unversioned docs/content/worlds/ collection (based on the v5 copies, with inline 4.x callouts for factory naming and 5.x-only env vars), rendered at /worlds/* - Add /worlds/building-a-world; flatten the docs Deploying section to a single intro page and drop its Rocket icon - Point every link, frontmatter ref, and worlds-manifest docs field at /worlds/*; add redirects for the removed v5 and building-a-world URLs - Keep world docs on agent-facing surfaces: search, llms.txt, sitemap.md/.xml, and .md exports now serve the worlds collection - Extend the docs link linter to validate worlds pages (with heading anchors) and their outgoing links Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Pranay Prakash <pranay.gp@gmail.com> * docs: version the world docs like the docs trees (v4/v5 switcher) Instead of a single unversioned copy, world docs now follow the same versioning strategy as the docs pages: content/worlds/v4 is served at /worlds/* (current) and content/worlds/v5 at /v5/worlds/*, restoring the original per-version content. Each world detail page (and Building a World) renders the docs version switcher — the worlds listing page has no natural home for it, so it lives on the world pages themselves. - Render-time href rewriting on v5 pages now covers /worlds/... links (shared rewriteHrefForVersion helper, also used by the v5 docs and cookbook routes), and the markdown-export rewrite does the same - v5 world pages are noindexed with a canonical to /worlds/<id>; community worlds stay unversioned (/v5/worlds/<id> redirects) - /v5/docs/deploying/world/* redirects now land on /v5/worlds/*; /v5/worlds and /v5/worlds/compare redirect to the unversioned pages - Link linter models the versioned worlds URL spaces (v5 pages resolve /worlds hrefs against the v5 collection); sitemap.md and the .md export routes cover /v5/worlds/* Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Pranay Prakash <pranay.gp@gmail.com> * docs: fix v4 multi-region anchor and tighten version-prefix matching Address PR review: - The v4 Deploying page linked /worlds/vercel#multi-region, but the Multi-region section only exists on the v5 world page; use the explicit cross-version /v5/worlds/vercel#multi-region link (this was the Docs Links CI failure) - rewriteHrefForVersion now uses the boundary-checked hasPathPrefix (shared leaf module lib/geistdocs/path-prefix.ts, also used by source.ts) instead of bare startsWith - buildVersionUrl's shared-route fast path is segment-based rather than substring includes() Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Pranay Prakash <pranay.gp@gmail.com> --------- Signed-off-by: Pranay Prakash <pranay.gp@gmail.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
109 lines
2.8 KiB
TypeScript
109 lines
2.8 KiB
TypeScript
import { IconWorkflow } from '@vercel/geistdocs/assets/icons/icon-workflow';
|
|
import { LogoAiElements } from '@vercel/geistdocs/assets/logos/logo-ai-elements';
|
|
import { LogoAiSdk } from '@vercel/geistdocs/assets/logos/logo-ai-sdk';
|
|
import { LogoChatSdk } from '@vercel/geistdocs/assets/logos/logo-chat-sdk';
|
|
import { LogoEve } from '@vercel/geistdocs/assets/logos/logo-eve';
|
|
import { LogoFlagsSdk } from '@vercel/geistdocs/assets/logos/logo-flags-sdk';
|
|
import { LogoTurborepo } from '@vercel/geistdocs/assets/logos/logo-turborepo';
|
|
import { defineConfig, type GeistdocsNavItem } from '@vercel/geistdocs/config';
|
|
import {
|
|
agent,
|
|
basePath,
|
|
github,
|
|
Logo,
|
|
nav,
|
|
prompt,
|
|
siteId,
|
|
suggestions,
|
|
title,
|
|
translations,
|
|
} from '@/geistdocs';
|
|
|
|
const isPreview =
|
|
process.env.VERCEL_ENV === 'preview' ||
|
|
process.env.NODE_ENV === 'development';
|
|
|
|
const visibleNav: GeistdocsNavItem[] = nav
|
|
.filter((item) => !item.preview || isPreview)
|
|
.map(({ preview: _preview, ...item }) => item);
|
|
|
|
export const config = defineConfig({
|
|
title,
|
|
agent,
|
|
defaultLanguage: 'en',
|
|
logo: <Logo />,
|
|
github,
|
|
nav: visibleNav,
|
|
// The package default list includes Workflow itself; drop it here since
|
|
// linking to the site you're already on is redundant.
|
|
navbarOssProducts: [
|
|
{ href: 'https://eve.dev/', logo: <LogoEve height={12} /> },
|
|
{ href: 'https://ai-sdk.dev/', logo: <LogoAiSdk height={12} /> },
|
|
{ href: 'https://flags-sdk.dev/', logo: <LogoFlagsSdk height={20} /> },
|
|
{ href: 'https://chat-sdk.dev/', logo: <LogoChatSdk height={20} /> },
|
|
{ href: 'https://turborepo.dev/', logo: <LogoTurborepo height={14} /> },
|
|
{
|
|
href: 'https://elements.ai-sdk.dev/',
|
|
logo: <LogoAiElements height={12} />,
|
|
},
|
|
],
|
|
basePath,
|
|
siteId,
|
|
translations,
|
|
content: [
|
|
{ id: 'docs', label: 'Docs', dir: 'content/docs/v4', route: '/docs' },
|
|
{
|
|
id: 'cookbook',
|
|
label: 'Cookbook',
|
|
dir: 'content/docs/v4/cookbook',
|
|
route: '/cookbook',
|
|
},
|
|
{
|
|
id: 'v5-docs',
|
|
label: 'v5 Docs',
|
|
dir: 'content/docs/v5',
|
|
route: '/v5/docs',
|
|
},
|
|
{
|
|
id: 'v5-cookbook',
|
|
label: 'v5 Cookbook',
|
|
dir: 'content/docs/v5/cookbook',
|
|
route: '/v5/cookbook',
|
|
},
|
|
{
|
|
id: 'worlds',
|
|
label: 'Worlds',
|
|
dir: 'content/worlds/v4',
|
|
route: '/worlds',
|
|
},
|
|
{
|
|
id: 'v5-worlds',
|
|
label: 'v5 Worlds',
|
|
dir: 'content/worlds/v5',
|
|
route: '/v5/worlds',
|
|
},
|
|
],
|
|
versions: {
|
|
current: 'v4',
|
|
items: [
|
|
{
|
|
id: 'v5',
|
|
label: 'v5 (Pre-release)',
|
|
description: 'Workflow 5.x',
|
|
routePrefix: '/v5',
|
|
icon: <IconWorkflow size={20} />,
|
|
},
|
|
{
|
|
id: 'v4',
|
|
label: 'v4 (Latest)',
|
|
description: 'Workflow 4.x',
|
|
icon: <IconWorkflow size={20} />,
|
|
},
|
|
],
|
|
},
|
|
ai: {
|
|
prompt,
|
|
suggestions,
|
|
},
|
|
});
|