mirror of
https://github.com/vercel/chat.git
synced 2026-09-14 18:32:29 +08:00
Ben Sabic
778ae69abc
Adapter Catalog: - Adds a zero-dependency `chat/adapters` subpath for official and vendor-official adapter metadata. - Includes typed catalog entries, env specs, peer dependency metadata, and helper APIs for setup and onboarding flows. - Wires the subpath into the `chat` package export map and build config. Code Coverage: - Adds unit coverage for catalog integrity, registry sync, helper behavior, official env declarations, and peer dependency derivation. - Extends docs integration coverage for `chat/adapters` imports and vendor-official package install metadata. Documentation: - Documents the new catalog on the adapter overview page. - Splits platform-specific adapter guidance into a new `/docs/platform-adapters` page. - Renames `/docs/state` to `/docs/state-adapters` and adds a redirect for the old slug. Agent Guidance: - Updates repo-local and public agent guidance so agents know when and how to use `chat/adapters`. - Adds focused `AGENTS.md` guidance inside `packages/chat/src/adapters` for future catalog maintenance. --------- Co-authored-by: Ben Sabic <bensabic@users.noreply.github.com>
57 lines
1.6 KiB
YAML
57 lines
1.6 KiB
YAML
name: Documentation Issue
|
|
description: Report a problem with the Chat SDK documentation
|
|
title: "I found a docs issue..."
|
|
labels: ["documentation"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for helping improve the Chat SDK docs! Please fill out the information below so we can fix the issue quickly.
|
|
|
|
- type: input
|
|
id: location
|
|
attributes:
|
|
label: Affected page or section
|
|
description: URL on chat-sdk.dev, or path in this repo (e.g., `apps/docs/content/docs/state-adapters.mdx`)
|
|
placeholder: https://chat-sdk.dev/docs/...
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: kind
|
|
attributes:
|
|
label: Type of issue
|
|
options:
|
|
- Typo or grammar
|
|
- Inaccurate or outdated information
|
|
- Unclear or confusing explanation
|
|
- Missing information
|
|
- Broken link
|
|
- Code example does not work
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Description
|
|
description: What's wrong, and what did you expect to see instead?
|
|
placeholder: Describe the issue...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: suggested-fix
|
|
attributes:
|
|
label: Suggested fix
|
|
description: If you have a suggested correction, share it here. Pull requests welcome — see CONTRIBUTING.md.
|
|
placeholder: ...
|
|
|
|
- type: textarea
|
|
id: additional
|
|
attributes:
|
|
label: Additional context
|
|
description: Screenshots, related issues, or anything else.
|
|
placeholder: Any additional information...
|