dvcrn/proton

Add 'usage guide' documentation

Open

#228 aperta il 21 ago 2016

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Clojure (51 fork)github user discovery
help wantedidea

Metriche repository

Star
 (560 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

A lot of questions could have been answered if proton had a proper usage documentation. We should add one at some point

Some ideas would be:

  • Explain editor navigation, jumping between panes, etc
  • Explain how to use the different input modes (vim-mode, vim-mode-plus, emacs, default)
  • Explain the concept of ,, syntax specific leader
  • Theme switch
  • proton.core.post-init-timeout
  • proton.core.wipeUserConfigs

Guida contributor

Direzione di ricerca
Ricerca la documentazione esistente di proton e le funzionalità elencate, quindi scrivi una guida completa che copra la navigazione dell'editor, le modalità di input, i tasti leader, il cambio di tema, proton.core.post init timeout e proton.core.wipeUserConfigs.
Tech stack
Nessuno
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80