Broad SEO/AEO pass across the docs site, adapter READMEs and AGENTS.md
files, and npm package metadata so Chat SDK content shows up better in
search engines, in LLM-driven package recommendations, and in
IDE/coding-agent context.
**Docs site**
- Adds a `## Resources` section to the Getting Started and AI overview
pages and to the Slack, Discord, GitHub, Liveblocks, and Sendblue
adapter pages, each linking to applicable guides/templates with
descriptions sourced from `resources-edge-config.json` and a cross-link
back to the central `/resources` hub.
**Adapter packages**
- Mirrors the same Resources sections into the Slack, Discord, and
GitHub READMEs (so they surface on npm) and into their AGENTS.md files
(so coding agents see them alongside the API notes).
- Expands `keywords` on every published adapter and state package — adds
`chat-sdk`, `chatbot`, `ai-agent`, `ai-sdk`, `vercel`, plus
platform-specific terms like `slack-bot`, `block-kit`, `slash-commands`,
`github-app`, `whatsapp-business`, `state-adapter`.
**Resources registry**
- Registers four new entries in `resources-edge-config.json`
(Human-in-the-Loop guide, Liveblocks AI agent guide, Slack + Vercel Blob
guide, Durable iMessage Agent template) and runs `pnpm sync-resources`
so the bundled `chat` package guides, `templates.json`, and
`skills/chat/SKILL.md` all pick them up.
- Fixes the synced Slack AI agent guide to import `toAiMessages` from
`chat/ai` instead of the deprecated `chat` re-export path (the upstream
KB source has also been updated, so future syncs will preserve this).
**Drive-by fixes**
- Resend adapter doc quick start: corrects `MemoryStateAdapter` class
import to the `createMemoryState()` factory (matching every other
adapter doc).
- Zalo adapter doc: drops the "community adapter" callout that
duplicated frontmatter.
**Tooling / CI**
- Adds `tsx` as a root devDependency so `pnpm sync-resources` works out
of the box (it previously relied on `npx tsx`, which hung when not
pre-cached).
- Loosens the CI changeset gate to also skip `packages/chat/resources/`
(generated data), matching the existing `*.md` carve-out.
---------
Co-authored-by: Ben Sabic <bensabic@users.noreply.github.com>
## summary
updates CI jobs that install pnpm to use Node versions compatible with
the current repo package manager
`Code Consistency` now follows `.nvmrc`, and the build/test matrix now
runs on Node 22 and 24 instead of Node 20 and 24
this fixes the `node:sqlite` setup failure from running `pnpm@10.30.3`
on Node 20
## summary
updates the release workflow to promote the `release` branch with
`--force-with-lease`
the previous plain push could fail when `release` had remote history
that was not present in the workflow checkout, even after packages
published successfully
this fetches the current `release` ref first, then updates it only if it
still matches the fetched commit
* set up konsistent with basic initial config
* add konsistent to CI
* fix konsistent.json formatting
* fix(gchat): move GoogleChatAdapterConfig to ./types for konsistent
* fix(slack): move SlackAdapterConfig to ./types and drop Partial wrapper from createSlackAdapter
* fix(messenger): name createMessengerAdapter parameter MessengerAdapterConfig
* fix(web): rename WebAdapterOptions to WebAdapterConfig and import Adapter type in index.ts
* fix(whatsapp): align WhatsAppAdapterConfig and creator with konsistent + map kebab to PascalCase
* fix(state-memory): add MemoryStateAdapterOptions type for konsistent
* fix(state-ioredis): unify URL and client options under IoRedisStateAdapterOptions
* fix(state-redis): unify URL and client options under RedisStateAdapterOptions
* fix(state-pg): unify URL and client options under PostgresStateAdapterOptions
* chore: changeset for konsistent convention alignment
* chore: drop CHANGELOG.md from konsistent's required files list
CHANGELOG.md is generated automatically by changesets on each release —
it's never hand-authored and doesn't exist for a package until its first
release lands. Requiring it as a convention check makes CI fail
indefinitely for any newly added package, with no honest fix available
(an empty placeholder is just noise that gets overwritten on first
release).
* docs: document konsistent and package shape conventions
* fix(web): use WebAdapterConfig in WebAdapter field types after main merge
The merge of main into konsistent brought in PR #475's `protected`
field modifiers on top of the WebAdapterOptions → WebAdapterConfig
rename, leaving two stale references to the (un-imported) old name.
Switch them to WebAdapterConfig and update a stale JSDoc reference
in als.ts to match.
---------
Co-authored-by: Ben Sabic <bensabic@users.noreply.github.com>
Co-authored-by: Ben Sabic <27636870+bensabic@users.noreply.github.com>
* add .nvmrc file
* follow up
* make support of Node >= 20 explicit
* update default Node version for contributing to the repo to 24
* run build-and-test CI job for both Node 20 and 24
* add changeset for package.json change
Pushes the published commit to the `release` branch so Vercel projects
configured with `release` as their production branch (docs, example app)
only deploy after a successful `changeset publish`.
Co-authored-by: Ben Sabic <bensabic@users.noreply.github.com>
* ci(release): pin changesets/action and enable npm provenance
Pin changesets/action to the v1.7.0 commit SHA, switch to GitHub-API
commit mode (signed commits via the API), set the version PR commit
and title to a conventional "chore(release): version packages", and
enable npm provenance attestations on publish via NPM_CONFIG_PROVENANCE.
* chore: add CODEOWNERS
Default ownership goes to @vercel/chat-sdk; release-plumbing paths
(release workflow, changeset config, CODEOWNERS itself) stay locked
to @cramforce since the publish workflow is bound to npm Trusted
Publisher by filename.
* docs: add SUPPORT.md and tidy issue contact links
Add a SUPPORT.md pointing users to docs, the issue chooser, and the
security advisory flow. Also update .github/config.yml: point the
Documentation contact link at chat-sdk.dev/docs (was a github.com
README anchor) and remove the GitHub Discussions entry, which 404s
because Discussions isn't enabled on the repo.
* chore: add docs issue and adapter request templates
Two new issue templates so reports come in pre-shaped:
- Documentation Issue — page/section, type (typo, outdated, missing,
broken link, etc.), description, suggested fix.
- Adapter Request — platform name, adapter type (platform/state), API
docs link, use case, existing community work, willingness to help
maintain.
* docs(contributing): point contributors at issue templates and SUPPORT.md
Add a "Reporting issues" section at the top of CONTRIBUTING.md that
links to the issue chooser (now covering bugs, features, docs issues,
and adapter requests) and to SUPPORT.md for general questions, with
the SECURITY.md private-disclosure path called out separately.
* chore: add pre-merge checklist to PR template
Adds four self-attestation boxes contributors can tick before
requesting review, surfacing requirements that already live in
CONTRIBUTING.md so they're not forgotten:
- Signed and verified commits (CONTRIBUTING explicitly bounces PRs
with unsigned commits).
- `pnpm validate` passes (lint, typecheck, tests, build in one go).
- Changeset added when a package's behavior changes.
- Docs updated for user-facing changes.
The "or N/A" wording on the last two avoids forcing a yes for
internal-only or docs-only PRs.
* chore: add Telegram and WhatsApp to bug report platform dropdown
The bug report platform dropdown was missing Telegram and WhatsApp,
which both have official adapters (@chat-adapter/telegram and
@chat-adapter/whatsapp). Reporters had to fall back to "Other" for
bugs in those adapters, losing the platform signal.
* docs(readme): fix CONTRIBUTING link path and add Support section
The Contributing section linked to ./CONTRIBUTING.md, but the file
actually lives at .github/CONTRIBUTING.md, so the link 404'd on
github.com. Repoint it.
Also add a Support section linking SUPPORT.md (general help) and
SECURITY.md (private vulnerability reporting) so those community
health files are reachable from the repo entry point instead of
only via GitHub's auto-surfacing.
* docs(contributing): add adapter authoring, commit conventions, and docs sections
Three additions to CONTRIBUTING.md to round out the file alongside
the recently added issue templates and PR checklist:
- "Building your own adapter" — points contributors who hit the
Adapter Request template at the existing community-adapter guide
on chat-sdk.dev rather than leaving them to discover it.
- "Commit messages" — codifies the Conventional Commits style the
repo already uses; the release workflow now relies on the
"chore(release): version packages" convention for its auto-PR,
so consistency in new commits keeps changelogs predictable.
- "Updating documentation" — names the apps/docs/content/docs/
source path, links the live site, and shows the local preview
command so the PR-template "Documentation updated" checkbox is
actionable.
* docs: trim agent docs, rename CLAUDE.md to AGENTS.md, add CLAUDE.md pointer
Move the agent guidance to AGENTS.md (the cross-tool convention) and
leave CLAUDE.md as a one-line "@AGENTS.md" pointer so Claude Code
keeps auto-loading the same content.
While renaming, trim and update the file:
- "packages/chat-sdk" was wrong — directory is "packages/chat", npm
name is "chat".
- Updated the package list to include adapter-{discord,telegram,
github,linear,zoom,shared}, state-{ioredis,pg}, integration-tests,
and the apps/docs and examples/nextjs-chat trees.
- Replaced the verbose recording-and-replay jq walkthrough with a
one-line pointer to the integration-tests README.
- Dropped the duplicated Changesets walkthrough — full guidance now
lives in CONTRIBUTING.md.
- Condensed ~120 lines of generic Ultracite/Biome rules to a short
list of non-obvious gotchas (Biome enforces the rest automatically).
- Added Conventional Commits (load-bearing for the release workflow's
auto-PR), the apps/docs/content/docs/ docs path with the "pnpm
--filter docs dev" preview command, a pointer to the community
health files, and POSTGRES_URL/DATABASE_URL for the new state-pg
adapter.
Net: 344 → ~125 lines.
* docs(nav): rename "Source" link to "GitHub"
---------
Co-authored-by: Ben Sabic <bensabic@users.noreply.github.com>
- Detect when files under packages/** have changed and skip the check otherwise
- Exclude markdown-only changes from triggering the check
- Run pnpm changeset status against the PR base branch to fail when a changeset is missing
Co-authored-by: Ben Sabic <bensabic@users.noreply.github.com>
Ben Sabic