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.

Table of Contents

• Organization information
• Ideas
  • Coding style guidelines
• Idea template

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

Coding style guidelines

• Project name: Coding style guidelines
• Description: We started to develop our coding style guidelines, but to this day, the document has not been finished yet. The goal of this project would be to go over the existing documentation, remove parts which aren't applicable, update parts which we do differently, and add guidelines we use, which aren't part of the guide yet.
• Difficulty: Challenging. There's a lot of information to process, both because the coding style we based ours on is long, and because one needs to be aware of the intricacies of embedded development.
• Related material:
  • Kaleidoscope#134
  • Current guidelines

Idea Template

NOTE: Do not edit this template directly, copy it and fill that out instead, and add an entry to the Table of Contents at the top of the page!

• 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.