dvcrn/proton

Add 'usage guide' documentation

Open

#228 opened on Aug 21, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Clojure (51 forks)github user discovery
help wantedidea

Repository metrics

Stars
 (560 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Research existing proton documentation and the features listed, then write a comprehensive usage guide covering editor navigation, input modes, leader keys, theme switch, proton.core.post init timeout, and proton.core.wipeUserConfigs.
Tech stack
None
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80