ipfs/ipfs-desktop

feat: README cleanup

Open

#2635 aperta il 20 set 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (912 fork)batch import
P3exp/beginnerexp/novicehelp wantedneed/community-inputneed/maintainers-inputtopic/devexp

Metriche repository

Star
 (5632 star)
Metriche merge PR
 (Merge medio 14g 4h) (4 PR mergiate in 30 g)

Descrizione

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?

Guida contributor

Direzione di ricerca
Rivedi le sezioni FAQ e Risoluzione dei problemi dell'attuale README. Considera il modello di Homebrew da TROUBLESHOOTING.md e COMMON ISSUES.md. Commenta l'issue con il tuo approccio proposto e affronta le preoccupazioni relative alla rottura dei link. Attendi il feedback del maintainer prima di implementare.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
In attesa del maintainer
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
Markdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70