ipfs/ipfs-desktop

feat: README cleanup

Open

#2.635 geöffnet am 20. Sept. 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (5.632 Stars) (912 Forks)batch import
P3exp/beginnerexp/novicehelp wantedneed/community-inputneed/maintainers-inputtopic/devexp

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
needs maintainer response
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Markdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.