ipfs/ipfs-desktop

feat: README cleanup

Open

#2,635 建立於 2023年9月20日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)JavaScript (5,632 star) (912 fork)batch import
P3exp/beginnerexp/novicehelp wantedneed/community-inputneed/maintainers-inputtopic/devexp

描述

Our FAQ & Troubleshooting section is getting fairly large.

Let's follow the pattern in brew's repo with a main TROUBLESHOOTING.md and COMMON-ISSUES.md doc

There are also some other cleanup actions we can perform to make things a little more hospitable to our users.

### Tasks
- [ ] Create table of contents
- [ ] clean up troubleshooting & faq section according to conclusions we come to on this issue.

Questions/Concerns:

  1. If we update troubleshooting to a new document, some existing links in issues (open and closed) will break. Are we okay with this?
  2. If we don't want to move troubleshooting/faq, how else can we clean things up?

貢獻者指南

技術棧
javascript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Markdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Review the current README's FAQ and Troubleshooting sections. Consider the pattern from Homebrew's TROUBLESHOOTING.md and COMMON ISSUES.md. Comment on the issue with your proposed approach and address the concerns about link breaking. Wait for maintainer feedback before implementing.