Documentation TODO

The objective of this file is to document the items flagged as @TODO as I go through the documentation so I come back to them and ensure they're resolved before the documentation is put live.

General things

• Regenerated ToC for each file using markdown-toc when ready to do final import to GitHub

About Mycroft

• Release note - need to find a way to aggregate them from GitHub. This will need the GitHub API.

• Overview - put in a link to the Precise documentation when it is done.

Your home.mycroft.ai account

• Advanced settings - need to get someone to review what I've written about things like the Threshold and Dynamic Energy Ratio.

• Registration code for Android - not sure how this works or how Android provides a Registration Code

• How to do multiple Wake Words

Mark 1

• Mark 1 - how to connect using an ethernet cable

• Mark 1 - what are the limitations around what type of WiFi networks Mark 1 can connect to - for instance, can Mycroft connect to WEP networks, enterprise WPA2-PSK with Radius authentication etc.

• Mark 1 - how to keep the Device updated - I've put something in there, but I'm not sure how accurate it is - needs Dev Team to give it the once over.

• Mark 1 - should the information on how to control the display for the Mark 1 Enclosure go under the Skills section instead?

• Mark 1 - how many characters can the Mark 1 display show before text has to scroll?

• Mark 1 - the mouth_display_png() optional parameters need to be checked - I've guess what each of them mean, but this needs to be checked.

• Mark 1 - the pieces about how to draw to the Enclosure - I think this needs an explanatory graphic.

Picroft

• Picroft - how to keep updated - is burning a new disk image to SD card the best approach?

Mycroft for Linux

• Linux - should people be connecting headphones and microphones through USB or Bluetooth? Is there any difference or preference? Is this information the same as for Picroft?

• Linux - what are the other installation options for Mycroft on Linux - there are the installers that @AIIX provided, and I think there's an apt-get package. Will need to clarify.

• Not sure what the easiest way is to keep Mycroft for Linux updated - is it as simple as doing a git pull from the remote repo?

• What are the common issues with Mycroft for Linux?

Mycroft for Android

Padatious

• Why is having Intents independent of each other a benefit - what does this mean - need to explain it in a bit more detail

Mycroft Skills

• Need more documentation on msm - what it does, what commands are available, what Skills developers need to know about it.

• What are the common issues in Skills development - ie the common problems that Developers encounter - so we can address them.

• How are Skills developed for platforms like Alexa repurposed for Mycroft?

• We need a guide or similar for __init__.py - that covers items like how to inherit from the MycroftSkill class, and the sorts of functions that are used. How are APIs used? What if your Skill needs to use another service?

• Is the copyright notice that's in __init__.py legally required, or can a Community Developer release a Skill using a different license?

Mycroft language support

• The introductory text is available in multiple languages - are there any key languages that I'm missing?

• If I find a STT engine in the language I want to support, what do I do with it? The documentation on the Languages wiki isn't clear how all the elements come together.

Precise

NIL

Adapt

• are there minimum requirements for installing Adapt - both software and hardware?

Audio service

• what URI schemas are supported by the Playback Skill?

• have the audio service backends been tested on Mark 1 yet?

• [ ]

Configuration

There is a need for documentation on mycroft.conf, but I'm not sure where to start with this, possibly a conversation with Steve to bring me across how it works - precedence, why the file lives in different locations etc.