Current Status of MATRIX Documentation


#1

Hello Everyone,

Over the past month we have been updating and revamping the MATRIX documentation to make it simpler, more informative, and bring it up to date. Below is a list of current and future changes being made to the MATRIX documentation. Over the coming weeks and months, we will make additional posts for any new updates.

As we continue to update the documentation we’d like to hear your suggestions and feedback. To help us improve our documentation please submit any issues or suggestions in the GitHub issues tab of the MATRIX Documentation repository.

Thank you all for your support! We are committed to continuously improving our platform to make it the best we can for you, the MATRIX Community.

Sincerely,
Team MATRIX

Documentation Added

General

  • Created individual pages for the MATRIX Voice & MATRIX Creator setup and resources.

  • Overview page has been updated to give users a better understanding of where to start.

  • Prism.js has been added to improve code snippets.

  • Fixed search bar.

  • Added MATRIX Creator and MATRIX Voice icons to indicate device compatibility on certain pages.

  • Added documentation for how to use the MATRIX Creator and MATRIX Voice microphones through ALSA.

MATRIX OS

  • Previous documentation has been updated, restructured, and better explained.

  • Pages with broken features have been removed to avoid confusion.

  • Marked as “Under Maintenance” while lower-level changes in the MATRIX ecosystem are being done.

    • NOTE: Recent improvements to the way we dynamically handle LEDs have caused MATRIX Voice LEDs to not work with MATRIX OS.

MATRIX CORE

  • Previous documentation has been updated, restructured, and better explained.

  • Updated examples for Javascript and Python have been added.

  • Added documentation for offline wakeword using Pocketsphinx.

MATRIX HAL

  • Update, restructure, and better explain documentation.

  • Add documentation for how to use the microphone array on your MATRIX device.

Upcoming Documentation

General

  • Add ESP32 examples and documentation.

MATRIX CORE

  • Add documentation for how to use the microphone array on your MATRIX device.

  • Add documentation for how to use zigbee and Zwave.


#2