---
name: docs
description: "Comprehensive user guide and platform documentation for Maxy. Load references when users ask how-to, setup, or troubleshooting questions. Also contains platform architecture references for admin use."
metadata: {"platform":{"always":true,"embed":["public","admin"],"pluginKey":"docs"}}
---

# Maxy Documentation

This plugin is the single source of truth for Maxy documentation. It ships with every install and is always the version the user has installed.

Load the relevant reference when the user asks a how-to question, requests help with setup, reports an issue, or wants to understand how something works.

## User Guide

Load these when users ask about Maxy features or need guidance:

- **Getting started** → `references/getting-started.md` — first run, what Maxy is, how to use it
- **Plugins** → `references/plugins-guide.md` — what plugins are, how to install/remove them, the marketplace
- **Memory** → `references/memory-guide.md` — how Maxy remembers things, what is stored, privacy
- **Contacts** → `references/contacts-guide.md` — adding, looking up, and managing contacts
- **Telegram** → `references/telegram-guide.md` — Telegram setup, the bot, daily use
- **Settings** → `references/settings.md` — output style, effort level, context mode, account preferences
- **Access Control** → `references/access-control.md` — who can chat with your public agent, invitations, authentication
- **Troubleshooting** → `references/troubleshooting.md` — common issues and how to resolve them

## Platform Reference

Load these when performing admin tasks or diagnosing platform behaviour:

- **Platform architecture** → `references/platform.md` — how the platform works, agent types, the plugin model
- **Deployment** → `references/deployment.md` — Pi setup, Cloudflare tunnel, start script

## References

- references/getting-started.md
- references/plugins-guide.md
- references/memory-guide.md
- references/contacts-guide.md
- references/telegram-guide.md
- references/settings.md
- references/access-control.md
- references/troubleshooting.md
- references/platform.md
- references/deployment.md
