How do I properly add newly generated docs to mruby.github.io?
Personne n'a encore pris cette issue.
- Langage dominant
- SCSS
- Étoiles
- 26
- Forks
- 32
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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!
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
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.
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.
Évaluation
- Stack technique
- ruby
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- Calme
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100