Automatically update gh-pages after Documentation and examples have been committed
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 153
- Forks
- 46
- Ø Merge
- 1 T. 8 Std.
- Gemergte PRs (30 T.)
- 7
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, den gh-pages-Publishing-Workflow sowie die Einstiegspunkte für den Build der Dokumentation und der Beispiele zu finden. Führe npm run doc aus, um die generierte API-Dokumentation zu verstehen, und überprüfe anschließend, dass Änderungen an der Dokumentation Aktualisierungen von gh-pages auslösen, ohne generierte Dateien zu committen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- ci-cd, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100