How do I properly add newly generated docs to mruby.github.io?
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- Calme
- Stack technique
- ruby
- Domaine
- documentation
Piste de recherche
Commencez par examiner la page générée mruby_2Fstring.h.html, le chemin de génération de mruby-yard et la mise en page existante de mruby.github.io. Lisez le PR #39 précédent concernant le problème de taille, puis confirmez le processus actuel de publication avec les mainteneurs. C'est terminé lorsqu'une procédure est convenue et, si cela est demandé, qu'un PR la suivant a été créé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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!
- Langage dominant
- SCSS
- Étoiles
- 26
- Forks
- 32
- Merge moyen
- 1 j 12 h
- PR mergées (30 j)
- 1
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de mruby/mruby.github.io
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
mruby/mruby.github.io#209 · 1 commentaire · 1 réaction ·
-
Gem staleness indicationOuverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 30/100
mruby/mruby.github.io#114 · 1 réaction ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 42/100
mruby/mruby.github.io#100 ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
mruby/mruby.github.io#99 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 25/100
mruby/mruby.github.io#98 ·
Toutes les issues de mruby/mruby.github.io
Issues similaires
-
tech-debt
Difficulté 2/5 Une demi-journée Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour
-
「無名コンストラクタは入れ子になっていても使用できる」は誤りOuverteバグ・誤り・不備
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
lean-ja/lean-by-example#2641 ·
-
agent-butler-finding chore
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
jordansmall/spindrift#5575 ·
Les mainteneurs répondent en général sous 1 jour
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
IntersectMBO/developer-experience#363 ·
Les mainteneurs répondent en général sous 2 jours
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
stellar/stellar-docs#2921 ·
Les mainteneurs répondent en général sous 1 jour