How do I properly add newly generated docs to mruby.github.io?
還沒有人認領這個 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!
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 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