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.
feat: README cleanup · ipfs/ipfs-desktop#2635 | Good First Issue