3 code samples in your docs no longer compile

Ouverte Adaptée aux débutants
#4,782 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

  • #5018 par @KeuqS — fermée sans fusion

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
68/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Calme
Stack technique
typescript
Domaine
documentation

Piste de recherche

Commence par la page de documentation https://trigger.dev/docs/ai/prompts, section 'Prompts ’ Type utilities', et retrouve son fichier source dans le dépôt (recherche dans le répertoire docs les identifiants PromptHandle, PromptIdentifier, PromptVariables). Vérifie par rapport aux déclarations .d.ts publiées de @trigger.dev/sdk que ces exports ont disparu, puis supprime ou réécris les trois exemples pour qu'ils passent la vérification de types. Lorsque snippetcheck ne remonte plus d'export supprimé pour cette page, c'est terminé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
TypeScript
Étoiles
16.5k
Forks
1.5k
Merge moyen
1 j 15 h
PR mergées (30 j)
17

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de triggerdotdev/trigger.dev

Toutes les issues de triggerdotdev/trigger.dev

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.