Automatically update gh-pages after Documentation and examples have been committed
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 153
- Fork
- 46
- Merge medio
- 1g 8h
- PR unite (30g)
- 7
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando il workflow di pubblicazione di gh-pages e i punti di ingresso della build della documentazione e degli esempi. Esegui npm run doc per comprendere la documentazione API generata, quindi verifica che le modifiche alla documentazione attivino gli aggiornamenti di gh-pages senza eseguire il commit dei file generati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- ci-cd, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100