3 code samples in your docs no longer compile

Aberta Para iniciantes
#4,782 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

  • #5018 de @KeuqS — fechado sem integrar

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
68/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Pouca atividade
Stack de tecnologia
typescript
Domínio
documentation

Direção de pesquisa

Comece na página de documentação https://trigger.dev/docs/ai/prompts, seção 'Prompts ’ Type utilities', e localize o arquivo-fonte dela no repositório (pesquise no diretório docs pelos identificadores PromptHandle, PromptIdentifier, PromptVariables). Verifique, frente às declarações .d.ts publicadas de @trigger.dev/sdk, que essas exportações não existem mais e então apague ou reescreva os três exemplos para que passem na verificação de tipos. Está pronto quando snippetcheck não reportar mais achados de exportações removidas para essa página.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
16.5k
Forks
1.5k
Merge médio
1d 15h
PRs com merge (30d)
17

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de triggerdotdev/trigger.dev

Todas as issues de triggerdotdev/trigger.dev

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.