Season of Docs 2019

Kaleidoscope is applying to participate in Google's Season of Docs in 2019, this is the landing page for that. This page is a collection of information regarding the Season, including a link to ideas and any other useful information.

Kaleidoscope is a plugin- and Arduino-based firmware for computer input devices. The firmware tries to follow the Arduino tradition of making common tasks easy for the novice user. One of our goals is to allow one to get started fast, without little prior knowledge. Documentation is a key part of that.

Ideas listed below also have their corresponding issue on the main Kaleidoscope repository, all labeled with Season of Docs. If you have a new idea, please open an issue, and copy & fill out the template at the end of this page too.

Organization information

• Organization name: Kaleidoscope
• Organization description: A plugin- and Arduino-based firmware for computer input devices.
• Organization repository: https://github.com/keyboardio/Kaleidoscope
• Organization website: https://kaleidoscope.keyboard.io/ (source)
• Organization admins and mentors: @obra, @algernon

Ideas

Template

NOTE: Do not edit this template directly, copy it and fill that out instead!

• Project name: Choose a concise but descriptive title.
• Description: A longer description of the documentation work required. Describe your initial idea in detail. Offer opportunities for any interested technical writers to expand or refine the idea.
• Related material:
  • Link to the open source project that needs documentation. This should be a link to the matching issue on the Kaleidoscope repository.
  • If you're proposing a technical writing project that involves updates to an existing documentation set, link to that documentation set.
  • If you're proposing a tutorial or a set of how-to guides, describe the features or use cases that need documenting.
  • If you're proposing a contributor's guide, link to any existing README file or other relevant material if present. If there's nothing available yet, it's fine to say that.
  • Include links to similar documentation in other projects, if relevant.