docs: polish package READMEs, expand npm keywords, migrate to www.agentskit.io#313
Merged
Conversation
Every workflow was broken after the Fumadocs migration and the Node 25
Docusaurus breakage. Fixing in one pass.
Problems that were live on main:
- ci.yml, coverage.yml, size.yml, release.yml all ran 'pnpm build'
(no filter). Turbo tries to build every workspace project including
@agentskit/docs, which is Docusaurus-on-Node-25 and crashes on
'mdxCrossCompilerCache'. Every one of these jobs failed in CI.
- docs.yml still deployed @agentskit/docs (old Docusaurus) to GitHub
Pages. That site is a) retired, b) doesn't build anyway. The
replacement lives at apps/docs-next (Fumadocs) and deploys via
Vercel's GitHub integration, not GitHub Pages.
- ci.yml duplicated bundle-size enforcement by hand-rolling a
check_size bash function — size.yml already does this properly
via size-limit with the .size-limit.json budget. Paths were wrong
too (no packages/react/dist/index.js without the preceding build).
- Version drift across workflows: checkout@v4 vs v6, pnpm@v4 vs v5,
node 20 vs 22. doctor's recommendation is Node 22+.
What this does:
1. Standardize every workflow to:
actions/checkout@v4
pnpm/action-setup@v4
actions/setup-node@v4
node-version: 22
2. Replace every 'pnpm build' with 'pnpm --filter "./packages/*" build'.
Legacy docs is not in scope for CI until it's retired.
3. ci.yml — drop the hand-rolled size check. size.yml is the single
source of truth for bundle-size gates.
4. docs.yml — convert from 'deploy Docusaurus to GH Pages' to
'build @agentskit/docs-next on every relevant PR/push'. Deploy
is Vercel's job via the repo's GitHub App integration. Workflow
is now validation-only + path-filtered so it doesn't run for
unrelated changes.
5. release.yml — same filter fix, same version bumps. Changesets
action itself is unchanged.
No i18n wiring — per the i18n strategy RFC, translated content is
frozen during the Fumadocs migration, so the workflow has nothing
to do for locales.
Verified locally:
- pnpm --filter './packages/*' lint → 28/28 passing
- pnpm --filter './packages/*' build → 22/22 passing
- pnpm test → 22/22 passing, 538 tests
- pnpm exec size-limit → every package under budget
- pnpm --filter @agentskit/docs-next build → 74 routes clean
Refs #211
Vercel auto-detected Turbo and started adjusting defaults, which ended up running 'turbo build' at the repo root — that fans out to every workspace including @agentskit/docs (legacy Docusaurus, broken on Node 25). Explicit config pins framework = Next.js, builds packages first so workspace:* resolutions work, then builds the docs site. Skips unrelated commits via ignoreCommand to save build minutes. Paired with this file, the Vercel dashboard should set: Root Directory: apps/docs-next Framework: Next.js (auto-detected from this file) Node.js: 22.x
- Replace minimal hero with full 7-section landing (hero + demo, social proof, problem, solution, benefits, provider strip, CTA) - Add live hero demo: auto-cycling agent conversation that renders real React widgets (weather card, BTC price chart, order tracker, flight list) via tool calls — sells the "agents render components, not markdown" angle - Restore interactive example components (BasicChat, ToolUse, RAG, Multi-Agent, etc.) ported from the legacy Docusaurus site; wire them into each /docs/examples mdx - Fix /docs/examples index links (relative -> absolute) - Make package grid clickable; each card links to its package docs - Add live npm downloads + GitHub stars social-proof bar - Brand tokens (direction B: midnight/foam) applied throughout
Add visible, contextual contribution CTAs so more people can help grow the ecosystem. - /docs/contribute section: overview (with live contributor wall), good-first-issues (live GitHub list), local-setup, commit-style, rfc-process, roadmap - Homepage: "Built in the open" block with contributor avatars, issue counts, and CTAs; "Contribute" button in final CTA - Social proof bar: add live contributors metric - Top nav: add "Contribute" and "Examples" links - Every docs page: "Edit on GitHub" + "Open an issue" + "Contribute" footer row (wired via editOnGithub prop on DocsPage) - Reusable ContributeCallout added to every package overview, data-layer and agent docs page; adapters + tools pages get tailored copy - Migrating pages: post-migration CTA to share story back - Examples index: "Have a pattern we missed?" CTA - 404 page: custom not-found with contribute links - README.md: expanded Contributing section + contrib.rocks avatar grid
…ussion topics - ContributorWall: avatar grid now scrollable (max-h-200) to accommodate large lists; fallback to contrib.rocks SVG when GitHub API returns nothing (rate-limit / offline) so wall is never empty - /docs/contribute: add "Start a new discussion" topic table with pre-filled links (use cases, missing providers, migrations, DX friction, architecture Q&A, recipes, bugs, docs gaps) - /docs/contribute/good-first-issues: add 30+ curated seeded starter issues across DX, docs, adapters, tools, React/Ink, memory/RAG/eval, observability, examples - /docs/contribute/local-setup: add hot-reload section explaining pnpm dev watch + HMR workflow (two-terminal tip) - /docs/contribute/commit-style: replace fake enforcement claims with honest 'planned + good-first-issue' plan to wire commitlint + husky + CI step (turns it into a concrete starter ticket)
- New AnimatedLogo component (CSS-only, zero deps) - Intro: lines draw in via stroke-dasharray, dots pop via cubic-bezier scale - Loop variant: dots breathe (3.2s pulse) after intro - Hover: lines shimmer + dots bounce - Variants: nav (small), hero (glow + slow), footer (fast) - prefers-reduced-motion snaps to final state, no animation - Wired into nav, homepage hero, final CTA, 404 page
…tion - animated-logo.css: remove all animations, keep static SVG + hero glow - hero-demo: assistant bubble uses word-break: break-word + overflow-wrap: anywhere so long sentences wrap inside card width; inner column constrained to max-w-[92%] w-full so flex child doesn't grow to content - hero-demo: remove 'agent renders real components · not markdown' caption from footer; keep scene pills only, centered
- Cap body at h-[460px]; messages area overflow-y-auto with thin scrollbar - useLayoutEffect scrolls to bottom on every frame update so incoming tokens + widget renders keep the latest content visible - Input bar moved outside scroll container, sticks to bottom with its own top-border separator
- Define --ak-* as CSS vars; :root holds light-mode values, .dark overrides with the original palette-B dark values - @theme now points each --color-ak-* at its var, so bg-ak-midnight, text-ak-foam, border-ak-border etc. swap automatically when Fumadocs toggles the .dark class on <html> - Light palette: clean inverted GitHub-style (#fff bg, #0D1117 text, #f6f8fa surface, #d0d7de border, accessible green/blue/red)
- Caption above grid: '↓ click any package to open its docs' - Each card now shows an arrow on hover + hover shadow ring - Caption below grid links to /docs 'browse all →' - aria-label per card for screen readers
- app/robots.ts: allow all, disallow /api, point at sitemap - app/sitemap.ts: enumerate 74+ docs pages via source.getPages(), priority/changefreq tuned per section - app/layout.tsx: add robots directives (index/follow + googleBot max-image-preview), keywords, authors, alternates.canonical, openGraph.locale, stronger default title - app/(home)/page.tsx: JSON-LD @graph (Organization + SoftwareApplication + WebSite w/ SearchAction) - app/docs/[[...slug]]/page.tsx: per-page alternates.canonical + openGraph article type + BreadcrumbList + TechArticle JSON-LD - components/seo/json-ld.tsx: reusable JSON-LD emitter - Fix domain inconsistency: agentskit.dev → agentskit.io across hero-demo + contribute docs (layout canonical was already .io)
- /api/og/route.tsx: accent top bar + section pill colored per section (getting-started=blue, examples=green, recipes=amber, contribute=red, concepts=violet, etc.), bottom-right domain badge in accent - docs [[...slug]]/generateMetadata now injects /api/og?title=&description=§ion= into openGraph.images and twitter.images so every docs page gets a unique share card - layout.tsx: verification metadata scaffold for GSC + Bing codes
Main received the squash-merged #301 homepage rebuild; this branch already contains that work plus follow-up polish (contribute hub, animated brand, light mode, SEO, OG per-page, hero-demo scroll fix, domain normalization). Keeping HEAD resolves every conflict since HEAD is strictly newer.
…mplates React + ink starters referenced react/jsx-runtime in TS but shipped no @types/react in devDependencies, causing TS2307 errors in fresh scaffolds. Runtime + multi-agent starters unchanged (pure Node).
…entskit.io - Polished all 14 package READMEs: positioning hook, shields badges (npm, downloads, bundle, license, stability, stars), discoverability tags, benefit-focused Why sections, contrib.rocks graph. - Expanded keywords in every package.json (9 → 16-20) for npm search: baseline ai/agents/llm/agentskit/openai/anthropic/claude/gemini/chatgpt plus package-specific tags. - Root README gained extra badge row (stars, issues, PRs, last-commit). - Migrated all doc URLs https://agentskit.io → https://www.agentskit.io across READMEs, CLI source (init, init-interactive), docs-next (layout, sitemap, robots, home, docs page). - Removed obsolete demo assets (demo/, scripts/record-demo.sh, scripts/seed-good-first-issues.sh, public/demo-init.*). - Added docs/DESIGN.md color-token canonical reference.
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
# Conflicts: # README.md # apps/docs-next/app/(home)/page.tsx # apps/docs-next/app/docs/[[...slug]]/page.tsx # apps/docs-next/app/robots.ts # apps/docs-next/app/sitemap.ts
EmersonBraun
added a commit
that referenced
this pull request
Apr 16, 2026
Re-publish only — the Fumadocs migration (#286, #313, #314) rewrote every package README to link to www.agentskit.io, but none of the packages have been republished since, so npmjs.com still surfaces the legacy emersonbraun.github.io URL. This patch bump across all 14 packages refreshes the READMEs in a single sweep.
2 tasks
EmersonBraun
added a commit
that referenced
this pull request
Apr 16, 2026
Re-publish only — the Fumadocs migration (#286, #313, #314) rewrote every package README to link to www.agentskit.io, but none of the packages have been republished since, so npmjs.com still surfaces the legacy emersonbraun.github.io URL. This patch bump across all 14 packages refreshes the READMEs in a single sweep.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
keywordsin everypackage.jsonfrom ~9 to 16-20 entries for npm search. Baseline:ai,agents,llm,agentskit,openai,anthropic,claude,gemini,chatgptplus per-package tags (e.g.react-hooks,vector-search,function-calling,code-interpreter).https://agentskit.iotohttps://www.agentskit.ioacross READMEs, CLI source, and docs-next app (layout, sitemap, robots, home JSON-LD, docs page canonicals).demo/,scripts/record-demo.sh,scripts/seed-good-first-issues.sh,apps/docs-next/public/demo-init.*.docs/DESIGN.mdwith canonical dark/light color token reference.Test plan
pnpm lintpassespnpm buildpassespnpm --filter @agentskit/docs-next buildsucceeds with new URLswww.agentskit.ioagentskit initCLI output shows new doc linksagentskit.iooutside historicaldocs/PHASE-0-*.md