ipfs / ipfs/ipfs-desktop

feat: README cleanup

Open
#2,635 0 comments 0 reactions 0 assignees View on GitHub
exp/beginner exp/novice help wanted need/community-input need/maintainers-input P3 topic/devexp
Dominant language
JavaScript
Stars
6.6k
Forks
903
Avg merge
4d 13h
Merged PRs (30d)
5

Description

Our FAQ & Troubleshooting section is getting fairly large.

Let's follow the pattern in brew's repo with a main [TROUBLESHOOTING.md](https://github.com/Homebrew/brew/blob/master/docs/Troubleshooting.md) and [COMMON-ISSUES.md](https://github.com/Homebrew/brew/blob/master/docs/Common-Issues.md) doc

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

```[tasklist]
### 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

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.