How do I properly add newly generated docs to mruby.github.io?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- SCSS
- Sterne
- 26
- Forks
- 32
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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!
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 mit der Überprüfung der generierten mruby_2Fstring.h.html-Seite, des mruby-yard-Generierungspfads und des bestehenden mruby.github.io-Layouts. Lies den früheren PR #39 wegen der Bedenken hinsichtlich der Größe und bestätige anschließend den aktuellen Veröffentlichungsprozess mit den Maintainer:innen. Erledigt ist die Aufgabe, wenn ein abgestimmtes Verfahren vorliegt und, falls angefordert, ein diesem Verfahren folgender PR erstellt wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- ruby
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 35/100