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 (912 Forks)batch import
P3exp/beginnerexp/novicehelp wantedneed/community-inputneed/maintainers-inputtopic/devexp

Repository-Metriken

Stars
 (5.632 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T 12h) (6 gemergte PRs in 30 T)

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

Research-Richtung
Überprüfe die README, um die aktuelle Struktur zu verstehen, erstelle TROUBLESHOOTING.md und COMMON ISSUES.md nach dem Homebrew Muster, verschiebe den Inhalt aus der README in die neuen Dateien, aktualisiere Links und füge ein Inhaltsverzeichnis hinzu.
Tech Stack
Keine
Domain
documentationdeveloper experience
Issue Type
Dokumentation
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 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85