-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
How do I properly add newly generated docs to mruby.github.io? #45
Comments
It looks like @sagmor wrote a script to do this, but I'm not sure. |
@zzak That script generates the docs from the mruby repo. I'm not sure what to do next about the PR. I used the scipt
It still seems like it will make for a huge PR. |
@Mav7 Right, yeah my guess is because they just haven't been generated in a while |
@zzak So how would I go about doing PR then? It's still seems to be to much. |
@Mav7 I mean, I think it's fine to send a PR to update the site -- but in the long run it's better to have this done automatically. |
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!
The text was updated successfully, but these errors were encountered: