[Proposal] Add user guide, especially about directives
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- ruby
研究方向
先檢閱 issue 中連結的日文 RDoc 指南,特別是其中對指令的涵蓋內容。定義一份涵蓋指令及其他 RDoc 功能的英文使用者指南範圍,然後翻譯並整理這些內容,使其成為提供給使用者和開發者的單一參考資料。
由索引模型根據 Issue 內容生成。
描述
I noticed that there's no list for directives. In fact, there's not a comprehensive user guide in English (the only I found was in Japanese: https://docs.ruby-lang.org/ja/latest/library/rdoc.html).
Adding user guide has two purposes. First, of course, users will refer to the guide so that they can use directives and other features of RDoc more effectively. Second, it will be a single source of truth for RDoc behavior so developers can rely on it.
I suggest the first version of the guide could be a direct translation of the Japanese guide mentioned above since we don't have to talk about what should be in the guide.
Any thoughts?
- 主要語言
- Ruby
- 星號
- 930
- 分支
- 472
- 平均合併
- 2 天 8 小時
- 30 天內合併 PR
- 12
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
ruby/rdoc 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation可能已有人在做 @OskarEichler 於 80 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 85/100
維護者通常 1 天內回覆
-
markdown html excerpt includes link parts可能已有人在做 @anyingiit 於 26 天前認領。 未關閉
難度 3/5 1-2 天 新手友好度 66/100
維護者通常 1 天內回覆
-
Regexp generated from unescaped input in #expand_class可能已有人在做 @jaynetics 於 39 天前認領。 未關閉
難度 1/5 1 小時以內 新手友好度 25/100
維護者通常 1 天內回覆
相似的 Issue
-
Update axe-core to v4.14.1可能已有人在做 @axe-core 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
dequelabs/axe-core-gems#539 ·
-
Pro request form loses all text when the subject is too long可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉bug f:request-creation professional
難度 2/5 1-3 小時 新手友好度 64/100
mysociety/alaveteli#9733 · 1 則留言 ·
維護者通常 1 天內回覆
-
needs verification
難度 2/5 1-3 小時 新手友好度 64/100
維護者通常 13 天內回覆
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
難度 2/5 1-3 小時 新手友好度 76/100
betagouv/conseillers-entreprises#4808 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100