dvcrn/proton

Add 'usage guide' documentation

Open

#228 创建于 2016年8月21日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Clojure (51 fork)github user discovery
help wantedidea

仓库指标

Star
 (560 star)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南

研究方向
研究现有的proton文档和列出的功能，然后编写一份全面的使用指南，涵盖编辑器导航、输入模式、前置键、主题切换、proton.core.post init timeout和proton.core.wipeUserConfigs。
技术栈
无
领域
documentationdeveloper experience
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80