Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,17 @@ DB, listener protocol) are injected via `init_injected_objects()`, so
`/config/restart` works. In standalone admin mode those endpoints fall back to
config-only / mock data, and restart is unavailable.


### What it looks like

**Widescreen**

![Every panel screen is this API with a face on it (widescreen)](img/dashboard.png)

**Mobile**

![Every panel screen is this API with a face on it (mobile)](img/dashboard-mobile.png)
Comment on lines +69 to +75

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ“ Maintainability & Code Quality | 🟑 Minor | ⚑ Quick win

Use visual descriptions for screenshot alt text.

The new alt text describes page purpose or uses promotional wording instead of describing the visible interface.

  • docs/api-reference.md#L69-L75: describe the dashboard elements visible in both screenshots.
  • docs/cli.md#L95-L101: describe the Clients page, its list, and visible controls.
  • docs/glossary.md#L139-L145: describe the dashboard content instead of stating that glossary terms appear there.
πŸ“ Affects 3 files
  • docs/api-reference.md#L69-L75 (this comment)
  • docs/cli.md#L95-L101
  • docs/glossary.md#L139-L145
πŸ€– Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/api-reference.md` around lines 69 - 75, Replace the promotional or
purpose-based screenshot alt text with concise visual descriptions: in
docs/api-reference.md lines 69-75, describe the dashboard elements visible in
both widescreen and mobile images; in docs/cli.md lines 95-101, describe the
Clients page, its list, and visible controls; and in docs/glossary.md lines
139-145, describe the visible dashboard content rather than mentioning glossary
terms.


---

## 1. Health & status
Expand Down
11 changes: 11 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,16 @@ can consume. This would also let the panel run fully **out-of-process or remote*
rather than only in-process. Until then, treat `/connections` live data as
advisory and rely on the database-backed views for authoritative state.


### What it looks like

**Widescreen**

![Topology, the architecture as the running system sees it (widescreen)](img/topology.png)

**Mobile**

![Topology, the architecture as the running system sees it (mobile)](img/topology-mobile.png)

---
[← Test Chat](test-chat.md) Β· [Home](index.md) Β· [Extending β†’](extending.md)
14 changes: 14 additions & 0 deletions docs/bridges.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,19 @@ you can revoke it like any other client (which immediately drops it).
- Give bridges a recognizable client name. The `bridge:<platform>` tag is what
the panel uses to label them, so keep it if you edit tags.


### What it looks like

Bridges are configured per bridge, but they all answer through the agent
selected here:

**Widescreen**

![Agent Protocol, where the backend a bridge talks to is chosen (widescreen)](img/agents.png)

**Mobile**

![Agent Protocol, where the backend a bridge talks to is chosen (mobile)](img/agents-mobile.png)

---
[← OVOS servers](ovos-servers.md) Β· [Home](index.md) Β· [Test Chat β†’](test-chat.md)
11 changes: 11 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,16 @@ Press `Ctrl-C` (SIGINT) to shut down cleanly. In the default hivemind-core + pan
hivemind-core runs on the main thread and installs the SIGINT/SIGTERM handlers, so the signal
is handled there and both hivemind-core and panel stop together.


### What it looks like

**Widescreen**

![Anything the CLI does to clients is visible here too (widescreen)](img/clients.png)

**Mobile**

![Anything the CLI does to clients is visible here too (mobile)](img/clients-mobile.png)

---
[← Running](running.md) Β· [Home](index.md) Β· [Configuration β†’](configuration.md)
19 changes: 19 additions & 0 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,5 +109,24 @@ You now know the vocabulary. Next:
- **[Tutorial](tutorial.md)** β€” do it all end-to-end.
- **[Glossary](glossary.md)** β€” any term, defined.


### What it looks like

A persona is the character the hive answers as:

![Personas: the character the hive answers as (widescreen)](img/personas.png)

![Personas: the character the hive answers as (mobile)](img/personas-mobile.png)

and the topology is every node currently attached:

**Widescreen**

<!-- duplicate screenshot removed -->

**Mobile**

![Topology: every node currently attached to the hive (mobile)](img/topology-mobile.png)

---
[Home](index.md) Β· [Getting started β†’](getting-started.md)
15 changes: 14 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ speech configs as [presets](presets.md) and select them here.
Which serialization encodings and ciphers clients may use. At least one of each must
stay enabled.

![Encodings &amp; ciphers](img/encodings.png)
![Encodings and ciphers, widescreen](img/encodings.png)

![Encodings and ciphers on a phone](img/encodings-mobile.png)

## Other config

Expand Down Expand Up @@ -151,5 +153,16 @@ client-impersonation variant that goes through the hub.
The same persona JSON can be hosted over an OpenAI or Ollama HTTP API by
**ovos-persona-server**. See [OVOS servers](ovos-servers.md).


### What it looks like

**Widescreen**

![Presets: saved configurations you can apply in one click (widescreen)](img/presets.png)

**Mobile**

![Presets: saved configurations you can apply in one click (mobile)](img/presets-mobile.png)

---
[← CLI](cli.md) Β· [Home](index.md) Β· [Plugin presets β†’](presets.md)
19 changes: 19 additions & 0 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,5 +104,24 @@ sudo systemctl enable --now hivemind-admin-panel
This single unit runs hivemind-core and the panel together. Add `--no-core` to the
`ExecStart` line if hivemind-core is managed by a separate service on the host.


### What it looks like

Audio streaming is configured in the binary protocol screen:

![Binary Protocol: the audio transport and its STT, TTS and VAD plugins (widescreen)](img/binary.png)

![Binary Protocol: the audio transport and its STT, TTS and VAD plugins (mobile)](img/binary-mobile.png)

and the listeners a deployment exposes are here:

**Widescreen**

![Network: the listeners a deployment exposes (widescreen)](img/network.png)

**Mobile**

![Network: the listeners a deployment exposes (mobile)](img/network-mobile.png)

---
[← Security](security.md) Β· [Home](index.md) Β· [OVOS servers β†’](ovos-servers.md)
11 changes: 11 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,16 @@ The end-to-end suite runs in `build-tests` and `coverage` on every PR.
to `master`. `dev` is the default branch.
- License: Apache-2.0. Keep the SPDX header on new source files.


### What it looks like

**Widescreen**

![Monitor: live message flow, the fastest way to see your change work (widescreen)](img/monitor.png)

**Mobile**

![Monitor: live message flow, the fastest way to see your change work (mobile)](img/monitor-mobile.png)

---
[← API reference](api-reference.md) Β· [Home](index.md) Β· [Roadmap β†’](roadmap.md)
11 changes: 11 additions & 0 deletions docs/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,5 +112,16 @@ hand-edit `version.py`, and work on a feature branch and let CI (the gh-automati
workflows) run build-tests, coverage, lint, and license-check. See
[Development](development.md).


### What it looks like

**Widescreen**

![OpenVoiceOS Plugins: what the panel can install and configure (widescreen)](img/voice-plugins.png)

**Mobile**

![OpenVoiceOS Plugins: what the panel can install and configure (mobile)](img/voice-plugins-mobile.png)

---
[← Architecture](architecture.md) Β· [Home](index.md) Β· [API reference β†’](api-reference.md)
11 changes: 11 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,16 @@ See [Running](running.md) for the difference between the two modes.
- [API reference](api-reference.md): drive everything over REST.
- [Deployment](deployment.md): Docker, Compose, or reverse proxy.


### What it looks like

**Widescreen**

<!-- duplicate screenshot removed -->

**Mobile**

![The sign-in screen you meet first (mobile)](img/login-mobile.png)

---
[← Concepts](concepts.md) Β· [Home](index.md) Β· [Tutorial β†’](tutorial.md)
11 changes: 11 additions & 0 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,5 +133,16 @@ Plain-language definitions of the terms a newcomer meets when running or operati

**XDG config**: the XDG Base Directory convention the panel follows for on-disk state. The shared hivemind-core config is `server.json` at `~/.config/hivemind-core/server.json` (honoring `XDG_CONFIG_HOME`). Personas, database profiles, and server registries live under sibling `~/.config/...` paths. See [Configuration](configuration.md).


### What it looks like

**Widescreen**

![Most terms in this glossary are labels on this screen (widescreen)](img/dashboard.png)

**Mobile**

![Most terms in this glossary are labels on this screen (mobile)](img/dashboard-mobile.png)

---
[← Tutorial](tutorial.md) Β· [Home](index.md) Β· [Troubleshooting β†’](troubleshooting.md)
Binary file added docs/img/acl-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/acl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/agents-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/agents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/binary-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/binary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/chat-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/clients-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/clients.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/dashboard-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/database-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/database.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/encodings-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/encodings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/login-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/monitor-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/nav-drawer-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/network-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/network.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/ops-mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/ops.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/personas-mobile.png
Binary file modified docs/img/personas.png
Binary file added docs/img/presets-mobile.png
Binary file modified docs/img/presets.png
Binary file added docs/img/servers-mobile.png
Binary file added docs/img/servers.png
Binary file added docs/img/topology-mobile.png
Binary file modified docs/img/topology.png
Binary file added docs/img/voice-plugins-mobile.png
Binary file added docs/img/voice-plugins.png
17 changes: 16 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ New here? Read **[Concepts](concepts.md)** first, then follow the

![Dashboard](img/dashboard.png)


### What it looks like

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ“ Maintainability & Code Quality | 🟑 Minor | ⚑ Quick win

Fix the heading level for What it looks like.

The page starts with an H1 and has no H2 before Line 14, so ### skips a heading level. Change it to ##, or add an H2 parent.

Suggested fix
-### What it looks like
+## What it looks like
πŸ“ Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### What it looks like
## What it looks like
🧰 Tools
πŸͺ› markdownlint-cli2 (0.23.2)

[warning] 14-14: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

πŸ€– Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/index.md` at line 14, Change the β€œWhat it looks like” heading from H3 to
H2 so the document heading hierarchy follows the existing H1 without skipping a
level.

Source: Linters/SAST tools


**Widescreen**

<!-- duplicate screenshot removed -->

**Mobile**

![The dashboard: security posture, live counts, and the plugins in use (mobile)](img/dashboard-mobile.png)

---

## Zero to running (newcomers)
Expand All @@ -23,7 +34,11 @@ Start here if you've never run HiveMind. No prior knowledge assumed.
your first satellite with a QR code, lock it down with an ACL, give it a
personality, and watch messages flow live.
4. **[Glossary](glossary.md)**: every term, defined.
5. **[Troubleshooting & FAQ](troubleshooting.md)**: when something does not work.
5. **[Troubleshooting & FAQ](troubleshooting.md)**: when something does not
work. Covers the failures people actually hit β€” a reinstalled satellite that
will not reconnect, two services fighting over port 5678, an upgrade that
leaves the hub on an old version, and a crash loop after a plugin goes
missing.

## Operate it (running a real deployment)

Expand Down
19 changes: 19 additions & 0 deletions docs/operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,5 +137,24 @@ gracefully.
- **Config dry-run**: `POST /config/diff` previews added, removed, and changed keys
before you apply a config.


### What it looks like

The client store behind all of it:

![Database: the client storage backend (widescreen)](img/database.png)

![Database: the client storage backend (mobile)](img/database-mobile.png)

and the operations screen itself:

**Widescreen**

![Operations: restart, backups, and log inspection (widescreen)](img/ops.png)

**Mobile**

![Operations: restart, backups, and log inspection (mobile)](img/ops-mobile.png)

---
[← Plugin presets](presets.md) Β· [Home](index.md) Β· [Security β†’](security.md)
11 changes: 11 additions & 0 deletions docs/ovos-servers.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,16 @@ agent/STT/TTS/database plugins hivemind-core uses.
- The broader OVOS server list also includes `ovos-bus-server`, `ovos-ww-server`,
and `ovos-opendata-server`.


### What it looks like

**Widescreen**

![OVOS Servers: the STT, TTS and other services in use (widescreen)](img/servers.png)

**Mobile**

![OVOS Servers: the STT, TTS and other services in use (mobile)](img/servers-mobile.png)

---
[← Deployment](deployment.md) Β· [Home](index.md) Β· [Chat bridges β†’](bridges.md)
11 changes: 11 additions & 0 deletions docs/presets.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,16 @@ restart):
Types: `stt` Β· `tts` Β· `ww` Β· `vad` Β· `agent` Β· `network`. Stored under
`~/.config/hivemind-core/plugin_presets/{type}/{name}.json`.


### What it looks like

**Widescreen**

<!-- duplicate screenshot removed -->

**Mobile**

![Presets: saved configurations you can apply in one click (mobile)](img/presets-mobile.png)

---
[← Configuration](configuration.md) Β· [Home](index.md) Β· [Operations β†’](operations.md)
11 changes: 11 additions & 0 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,16 @@ to hivemind-core. In `--no-core` mode these degrade gracefully (no live hivemind
- Passwords now support PBKDF2 hashes (`pbkdf2_sha256$...`) while still accepting
legacy plaintext for back-compat. Change one through `POST /auth/password`.


### What it looks like

**Widescreen**

![Where the panel stands today (widescreen)](img/dashboard.png)

**Mobile**

![Where the panel stands today (mobile)](img/dashboard-mobile.png)

---
[← Development](development.md) Β· [Home](index.md)
11 changes: 11 additions & 0 deletions docs/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,16 @@ hivemind-admin-panel --no-core --reload
| `--reload` | off | dev auto-reload (implies `--no-core`) |
| `--log-level` | `INFO` | log level for the in-process hivemind-core |


### What it looks like

**Widescreen**

<!-- duplicate screenshot removed -->

**Mobile**

![The dashboard reports which run mode the panel is in (mobile)](img/dashboard-mobile.png)

---
[← Troubleshooting](troubleshooting.md) Β· [Home](index.md) Β· [CLI β†’](cli.md)
11 changes: 11 additions & 0 deletions docs/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,16 @@ These are known and worth accounting for when deploying:
3. Network-isolate the host; the panel and the OVOS bus it can reach are trusted
surfaces.


### What it looks like

**Widescreen**

![Permissions: what each client is allowed to send (widescreen)](img/acl.png)

**Mobile**

![Permissions: what each client is allowed to send (mobile)](img/acl-mobile.png)

---
[← Operations](operations.md) Β· [Home](index.md) Β· [Deployment β†’](deployment.md)
11 changes: 11 additions & 0 deletions docs/test-chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,16 @@ or an [OVOS server](ovos-servers.md), or run your OVOS skills.

See the [API reference](api-reference.md) for details.


### What it looks like

**Widescreen**

![Test Chat: talk to the hive without a satellite (widescreen)](img/chat.png)

**Mobile**

![Test Chat: talk to the hive without a satellite (mobile)](img/chat-mobile.png)

---
[← Chat bridges](bridges.md) Β· [Home](index.md) Β· [Architecture β†’](architecture.md)
Loading
Loading