How do I properly add newly generated docs to mruby.github.io?
Nessuno ha ancora preso questa issue.
- Lingua principale
- SCSS
- Stelle
- 26
- Fork
- 32
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
The last bit of documentation I wrote was approved of and merged by @matz into mruby. Now I want to add the documentation to mruby.org. Usually what would happen is that I'd generate the doc using mruby-yard. In this case, the only thing that changed was that I added docs to string.h. So I'd then take the generated doc in this case a file called mruby_2Fstring.h.html. Then I'd just copy and paste it to the proper directory in mruby.github.io then I'd do a PR. Of course, if it's merged it would then go live. Is that still okay? Because I remember before @zzak said that the size was too big. I want to make sure I do this correctly this time!
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 esaminando la pagina generata mruby_2Fstring.h.html, il percorso di generazione di mruby-yard e il layout esistente di mruby.github.io. Leggi il precedente PR #39 per la questione delle dimensioni, quindi conferma l'attuale processo di pubblicazione con i maintainer. Il lavoro è completato quando è stata concordata una procedura e, se richiesto, è stato creato un PR che la segue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- ruby
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100