mruby / mruby/mruby.github.io

How do I properly add newly generated docs to mruby.github.io?

未关闭
#45 6 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
SCSS
星标
26
派生
32
PR 合并指标
30 天内没有已合并 PR

描述

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!

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查生成的 mruby_2Fstring.h.html 页面、mruby-yard 生成路径以及现有的 mruby.github.io 布局。阅读之前的 PR #39,了解对大小的担忧,然后与维护者确认当前的发布流程。达成一致的流程,并在需要时提交遵循该流程的 PR,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
ruby
领域
documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
冷清
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。