ipfs/ipfs-desktop

feat: README cleanup

Open

#2,635 opened on Sep 20, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (5,632 stars) (912 forks)batch import
P3exp/beginnerexp/novicehelp wantedneed/community-inputneed/maintainers-inputtopic/devexp

Description

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?

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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