49 lines
2.7 KiB
Markdown
49 lines
2.7 KiB
Markdown
---
|
|
slug: /
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# MetoYou Documentation
|
|
|
|
MetoYou is a desktop-first chat app with text channels, voice channels, direct messages, plugins, local desktop storage, a local REST API, and a Docusaurus documentation site bundled into the app.
|
|
|
|
This site is split into three paths:
|
|
|
|
- **User Guide** explains the app in non-technical terms: servers, text channels, voice channels, screen sharing, direct messages, plugins, and desktop settings.
|
|
- **Developer Guide** explains how to run the repo, how the app is structured, how Docusaurus is served, the app DOM/page structure, and the local REST API.
|
|
- **Plugin Development** explains how to build plugins, declare capabilities, distribute bundles, and call every exposed plugin API with concrete examples.
|
|
|
|
The Electron app can host this documentation locally. The docs endpoint is not a separate web server process: it is served from the same opt-in local HTTP server used for the Local API, and it only serves static files generated by Docusaurus.
|
|
|
|
## What Is Included
|
|
|
|
| Area | What it covers |
|
|
| --- | --- |
|
|
| Product client | Login, server discovery, channels, messages, voice, direct messages, themes, and plugin UI. |
|
|
| Desktop shell | Window controls, notifications, tray behavior, app data import/export, updates, local plugins, and hosted documentation. |
|
|
| Local HTTP API | A loopback-first API for local scripts and tools, with OpenAPI and Scalar reference docs. |
|
|
| Plugin runtime | Browser-safe client plugins with explicit capabilities, lifecycle hooks, UI contributions, data storage, message bus, and server plugin requirements. |
|
|
|
|
## Runtime Boundaries
|
|
|
|
MetoYou keeps responsibilities split by package:
|
|
|
|
- `toju-app/` is the Angular product client and plugin runtime.
|
|
- `electron/` is the main process, preload bridge, IPC, local persistence, and local HTTP host.
|
|
- `server/` is the signaling and server-directory service.
|
|
- `e2e/` contains Playwright coverage for browser and WebRTC workflows.
|
|
- `docs-site/` is this Docusaurus site.
|
|
|
|
The desktop documentation endpoint serves the static `docs-site/build` output. It does not run the Docusaurus development server inside Electron.
|
|
|
|
## Fast Links
|
|
|
|
- Start using the app: [First Steps](./user-guide/first-steps.md)
|
|
- Join voice: [Voice Channels and Calls](./user-guide/voice-channels.md)
|
|
- Install plugins: [Plugins for Users](./user-guide/plugins.md)
|
|
- Run the repo: [Contributing](./developer/contributing.md)
|
|
- Understand pages and DOM: [App Pages and DOM Structure](./developer/dom-structure.md)
|
|
- Use the REST API: [Local REST API](./developer/rest-api.md)
|
|
- Build a plugin: [Create a Plugin](./plugin-development/create-a-plugin.md)
|
|
- Give an LLM plugin context: [LLM Plugin Builder Guide](./developer/llm-plugin-builder-guide.md)
|