3 code samples in your docs no longer compile

オープン 初心者向け
#4,782 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

  • #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 宣言と照合して、これらのエクスポートが削除されていることを確認し、その後、3 つのサンプルを削除するか書き換えて型チェックが通るようにする。対ページで 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時間
マージ済み PR(30日)
17

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

triggerdotdev/trigger.dev のほかの issue

triggerdotdev/trigger.dev の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。