Automatically update gh-pages after Documentation and examples have been committed
Personne n'a encore pris cette issue.
- Langage dominant
- TypeScript
- Étoiles
- 153
- Forks
- 46
- Merge moyen
- 1 j 8 h
- PR mergées (30 j)
- 7
Description
Currently there seems to be a lack of automatic update of gh-pages when new documentation is added. We also need to generate the API documentation using npm run doc for gh-pages, since I think it's bad practice to commit files that are automatically generated anyway.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par localiser le workflow de publication de gh-pages ainsi que les points d’entrée du build de la documentation et des exemples. Exécutez npm run doc pour comprendre la documentation d’API générée, puis vérifiez que les modifications de la documentation déclenchent des mises à jour de gh-pages sans commiter les fichiers générés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- ci-cd, documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100