How do I properly add newly generated docs to mruby.github.io?
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Ruhig
- Tech-Stack
- ruby
- Bereich
- documentation
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.
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!
- Vorherrschende Sprache
- SCSS
- Sterne
- 26
- Forks
- 32
- Ø Merge
- 1 T. 12 Std.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus mruby/mruby.github.io
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
mruby/mruby.github.io#209 · 1 Kommentar · 1 Reaktion ·
-
Gem staleness indicationOffen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 30/100
mruby/mruby.github.io#114 · 1 Reaktion ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 42/100
mruby/mruby.github.io#100 ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
mruby/mruby.github.io#99 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 25/100
mruby/mruby.github.io#98 ·
Alle Issues in mruby/mruby.github.io
Ähnliche Issues
-
documentation good first issue help wanted
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
drevendev/HungryCrab#273 ·
Maintainer antworten meist innerhalb von 1 Tag
-
good first issue help wanted
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
drevendev/BeautifulRepo#19 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
documentation story
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
Maintainer antworten meist innerhalb von 1 Tag
-
Create a theming guideOffendocumentation good first issue theming
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100