Convex Docs

作者 get-convex2cfe645c87f9無授權條款63 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫6 天前更新

Pull version-current Convex docs for the version this project uses — pin the installed version, fetch page-as-markdown or check node_modules types, freshness hierarchy — instead of writing a possibly-stale API from memory.

AI 產生的概覽

取得與專案所用版本一致的 Convex 文件及已安裝套件型別,避免憑記憶撰寫過時 API。

功能
此技能為 Convex 開發定義了一套時效性工作流程:先鎖定已安裝的 convex 及 @convex-dev 元件版本,再依最省成本的正确順序取得文件(託管文件工具、頁面 markdown 或鎖定版本的 README,最後才是一般網路搜尋)。對於不確定的元件匯出,它會比對 node_modules 中已安裝套件的 exports 與型別宣告進行核實,並註明所用事實來自哪個頁面與版本。它只提供最新事實,慣用程式碼的撰寫仍交由搭配的 convex-expert 知識完成。
適用情境
適用於撰寫或修正可能依賴近期變更的匯出、CLI 參數或被重新命名 API 的 Convex 程式碼。也用於處理版本不符的建置錯誤,此時應重新鎖定版本並取得目前 API,而不是猜測拼字。
執行需求
需要存取專案的 node_modules 或 package.json 以讀取已安裝版本,並需要網路存取以取得 Convex 文件頁面或元件 README。託管文件工具或 MCP 的 search_convex_docs 端點為選用但優先。不附帶指令碼,僅為說明性內容。
<!-- GENERATED from convex-agents content/capabilities/convex-docs.json — do not edit by hand. -->

Pull version-current Convex docs

convex-expert carries baked, plugin-versioned knowledge — excellent for stable idioms, but it goes stale exactly where it hurts: a component that gained a new export, a CLI flag that changed, an API renamed between versions. This capability is the freshness discipline layered on top: pin to the project's real version, fetch the live page cheaply as markdown, and never write an unfamiliar API from memory when the current source is one fetch away.

Workflow

  1. PIN the version: read the installed convex version (node -p "require('./node_modules/convex/package.json').version" or package.json), and the versions of any @convex-dev/* components in play. The docs you trust must match THESE versions — version skew is the single largest source of wrong Convex code.
  2. FRESHNESS HIERARCHY (cheapest-correct first, the Supabase-taught order): (a) if a served docs tool / MCP search_convex_docs is available, use it (it returns version-scoped, reranked answers sized to the context window); (b) else fetch the specific docs page as MARKDOWN — request docs.convex.dev/<path> and prefer a .md/markdown form when the site serves one (far fewer tokens than HTML), or the component's README at the pinned version; (c) only then fall back to a general web search, and treat its version as unverified. Do NOT skip to writing the API from memory when currentness is in doubt.
  3. VERIFY against the installed package when it matters: for a component export you're unsure exists, check node_modules/@convex-dev/<x>/ (its package.json exports, its .d.ts) — the installed types are the ground truth for THIS version, more authoritative than any doc.
  4. USE the fetched fact narrowly: apply the current signature/flag, cite where it came from (page + version), and hand the actual code back to convex-expert to write idiomatically. convex-docs supplies the fresh fact; convex-expert supplies the idiom.
  5. On a version-mismatch build error (an export/flag that 'should' exist but doesn't): treat it as a currentness question — pin the version, fetch the current API, and correct — rather than guessing a different spelling.

Rules

  • Never write an unfamiliar or possibly-renamed Convex/component API from model memory when currentness is in doubt — pin the version and fetch the current source first.
  • The installed package's own exports/.d.ts in node_modules is the ground truth for this version — more authoritative than any doc page.
  • Follow the freshness hierarchy: served docs tool → page-as-markdown / pinned README → general web (unverified) — cheapest-correct first, fewest tokens.
  • Prefer markdown over HTML doc pages — far fewer tokens for the same content.
  • Supply the fresh FACT; hand idiomatic code back to convex-expert. This is a freshness layer, not a replacement for the baked knowledge.
  • A version-mismatch build error is a currentness question, not a spelling guess — re-pin and re-fetch.

來源與署名

來源:get-convex/agent-skills位於skills/convex-docs提交2cfe645

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架