3 code samples in your docs no longer compile

未關閉 適合新手
#4,782 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

  • #5018 來自 @KeuqS —— 已關閉,未合併

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
68/100
Issue 類型
文件
描述清晰度
基本清楚
活躍度
冷清
技術堆疊
typescript
領域
documentation

研究方向

從文件頁面 https://trigger.dev/docs/ai/prompts 的 'Prompts ’ Type utilities' 區段開始,在仓库中找到其原始檔(在 docs 目錄中搜尋識別子 PromptHandle、PromptIdentifier、PromptVariables)。對照已發佈的 @trigger.dev/sdk 之 .d.ts 宣告,確認這些匯出已不存在,然後刪除或改寫這三個範例,使其能通過型別檢查。當 snippetcheck 對該頁面不再回報已移除匯出的項目時即算完成。

由索引模型根據 Issue 內容生成。

描述

I ran snippetcheck against the trigger-dev-sdk docs — it type-checks every TypeScript sample in a docs site against the package's own published declarations, nothing executed.

Against @trigger.dev/[email protected], 3 findings marked included after review:

Kind Symbol Section Page
removed-export PromptHandle Prompts > Type utilities https://trigger.dev/docs/ai/prompts
removed-export PromptIdentifier Prompts > Type utilities https://trigger.dev/docs/ai/prompts
removed-export PromptVariables Prompts > Type utilities https://trigger.dev/docs/ai/prompts

Method: type-checked against the package's own .d.ts declarations, nothing executed. 267 of 970 extracted TypeScript samples checked. Skipped: 63 before-example, 117 historical-section, 230 no-target-import, 2 unsupported-language, 1 unparseable.

Happy to share the full report, or re-run this after your next release.

— David

主要語言
TypeScript
星號
16.5k
分支
1.5k
平均合併
1 天 15 小時
30 天內合併 PR
17

環境準備

這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

triggerdotdev/trigger.dev 的其他 Issue

查看 triggerdotdev/trigger.dev 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。