This directory contains the documentation for the MAX Toolkit.
Start with the MAX Toolkit README.md first, to get an overall idea of MAX Toolkit and its contents. Agent developers should start with the Integrating an Agent with MAX Library document. This documentation goes over all Agent use cases, MAX Library API usage, and multi-agent features enabled by integration. Device or application developers should start with Integrating a Device with MAX Library. Agent and device or application developers should then read Integrating with MAX Controls, Integrating with MAX Activities, Integrating with MAX Experiences and Overview of MAX Sample Application. To build and run the Sample Application refer to the MAX Sample Application Getting Started Guide.
Documentation:
- Glossary.md: A glossary of terms used in the documentation, and throughout the MAX Toolkit.
- Integrating_A_Device_With_MAX_Library.md: Guidance on integrating a device or application with the MAX Library.
- Integrating_An_Agent_With_MAX_Library.md: Guidance on integrating a voice agent with the MAX Library.
- Integrating_With_MAX_Activities.md: A description of MAX Activities, and how to integrate them with a device or agent.
- Integrating_With_MAX_Controls.md: A description of MAX Controls, and how to integrate them with a device or agent.
- Integrating_With_MAX_Experiences.md: A description of MAX Experiences, and how to integrate them with a device or agent.
- MAX_Sample_Application_Getting_Started_Guide.md: A getting started guide for the MAX Sample Application; prerequisites, building instructions, and running instructions.