---
name: docs
surface: platform
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
- **Graph view** → `references/graph.md` — the admin `/graph` page: node/edge display, zoom-adaptive Conversation labels, filter chips, trashed nodes
- **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, account preferences
- **Access Control** → `references/access-control.md` — who can chat with your public agent, invitations, authentication
- **Projects** → `references/projects-guide.md` — creating projects, tracking health, phase transitions, completing
- **Slides** → `references/slides.md` — generating, theming, and reviewing HTML slide decks with `/slides`
- **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
- **Platform internals** → `references/internals.md` — retrieval pipeline, embedding infrastructure, guard layers, graph expansion, keyword subscriptions, context assembly, tool call audit trail, programmatic spawn entry point and end-turn auto-close lifecycle. Load when answering architecture questions, assessing whether a capability exists, diagnosing retrieval behaviour, or reviewing security and privacy features.
- **Admin UI** → `references/admin-ui.md` — compact map of every `/api/admin/*` mount, every sidebar surface, the system-stats widget (CPU/RAM thresholds), the artefact pane, and the health-vs-version split. Load when diagnosing an admin route, explaining the CPU/RAM widget, or onboarding a new admin endpoint.
- **Admin session** → `references/admin-session.md` — signed sessionKey + PIN-rebind survival contract, SDK-resume across `systemctl restart`, and the single-entry `POST /api/admin/claude-sessions` wrapper that owns every programmatic admin spawn-with-initialMessage. Load when diagnosing admin session continuity, designing a programmatic admin spawn.
- **Cloudflare** → `references/cloudflare.md` — dashboard-first tunnel setup, the `cloudflared`-CLI-only tool surface, single-recovery-path (re-login) for every wrong-account failure.
- **Deployment** → `references/deployment.md` — Pi setup, Cloudflare tunnel, start script

## References

- references/getting-started.md
- references/plugins-guide.md
- references/memory-guide.md
- references/graph.md
- references/contacts-guide.md
- references/telegram-guide.md
- references/settings.md
- references/access-control.md
- references/projects-guide.md
- references/troubleshooting.md
- references/platform.md
- references/internals.md
- references/admin-ui.md
- references/admin-session.md
- references/cloudflare.md
- references/deployment.md
