Skip to content

feat(dashboard): docs, website and GitHub links; readable info popovers with docs links - #13

Merged
arg1998 merged 2 commits into
mainfrom
feat/dashboard-docs-links
Sep 17, 2026
Merged

arg1998 merged 2 commits into
mainfrom
feat/dashboard-docs-links

Conversation

@arg1998

@arg1998 arg1998 commented Sep 17, 2026

Copy link
Copy Markdown
Owner

What

Links to the docs, the website and GitHub

  • Top bar: a new Help menu (?) opens the guide section for the current page ("Help for Vault" and so on), the dashboard guide, MCP client setup, troubleshooting, keyboard shortcuts, browserhive.ai, the GitHub repository, what's new in the running version, and issue reporting.
  • Sidebar footer: Docs · GitHub · Website links, and the version number now links to its release notes. The collapsed rail shows Docs and GitHub icons.
  • Command palette: new actions open the documentation, the dashboard guide, the MCP client guide, the tool reference, the website and GitHub.
  • Fixed links: the "Connect an MCP client" link in the sessions empty state and the agent tokens empty state now point at browserhive.ai, not GitHub.

Info boxes

  • Formatting fix: the popover body was a flex column, so every inline <code>, <b> and <em> became its own line. It now renders as flowing text with paragraph spacing, code chips, an optional title, and a "Read the docs" footer link.
  • Docs-link props: PageHeader, StatTile, Section and Panel accept a docs link. The links are centralized in lib/links.ts, and a test checks every docs page and anchor against docs/.
  • New explainers with docs links:
    • Page headers: Overview, Websites, Vault (every state), Vault log and System.
    • System panels: Agent tokens, All configuration keys, Storage and retention, Schema migrations, Degradations.
    • Session detail: Identity & coherence, Playwright trace.
    • Vault confirmations.
    • Blocklist: the attempts section, plus a docs button on the not-configured state.
  • Existing explainers: Sessions, Logs, Blocklist and Attention now have a docs link and paragraphs.
  • System setting hints: they now name the real flags (--maxSessions, --allowEvaluate, --retentionDays, --allowInsecureBind; the old kebab-case spellings are rejected by the CLI) and link to each key in the configuration reference. Hints were added for data directory, fingerprint and humanize.

Website

  • /docs/errors and /docs/configuration now redirect to the references. The CLI prints those URLs and problem+json type URIs use them, so they no longer 404.

Verified

  • bun run typecheck, bun run lint, the dashboard tests (323), the lint and docs tests, and website:check pass.
  • Two tests asserted there were no docs links while the site didn't exist. They now assert the links point at browserhive.ai.
  • Checked visually against a seeded dev daemon, in dark and light, at 1440px and at 390px on touch: every info popover, the Help menu, the sidebar footer and the collapsed rail, the mobile drawer and the palette.

…rs with docs links

- Help menu in the top bar: guide for the current page, dashboard guide, MCP client setup,
  troubleshooting, keyboard shortcuts, browserhive.ai, GitHub, release notes, report an issue.
- Sidebar footer links to Docs, GitHub and the website; the version links to its release notes.
  The collapsed rail shows Docs and GitHub icons.
- Command palette actions open the docs, dashboard guide, MCP client guide, tool reference,
  website and GitHub.
- InfoDot renders its body as flowing text (inline code and bold stay inline, paragraphs are
  spaced), with an optional title and a Read the docs footer. PageHeader, StatTile, Section and
  Panel accept a docs link, and new explainers cover Overview, Websites, Vault, Vault log, System
  (tokens, configuration keys, storage, migrations, degradations), session identity and traces.
- lib/links.ts centralizes outbound URLs; a test resolves every docs page and anchor against
  docs/.
- System setting hints use the real camelCase flags and link to each key in the configuration
  reference.
- Website: /docs/errors and /docs/configuration (printed by the CLI and used in problem+json type
  URIs) redirect to the references.
@arg1998
arg1998 enabled auto-merge (squash) September 17, 2026 03:11
@arg1998
arg1998 merged commit 3752bc9 into main Sep 17, 2026
18 of 20 checks passed
@arg1998
arg1998 deleted the feat/dashboard-docs-links branch September 17, 2026 03:22
arg1998 pushed a commit that referenced this pull request Sep 17, 2026
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## browserhive@0.1.3

### Patch Changes

- [#13](#13)
[`3752bc9`](3752bc9)
Thanks [@arg1998](https://github.com/arg1998)! - Dashboard: links to the
documentation on browserhive.ai, the website and GitHub.

- A Help menu in the top bar opens the guide for the current page, the
dashboard guide, MCP client setup, troubleshooting, release notes and
issue reporting.
- The sidebar footer links to Docs, GitHub and the website, and the
version links to its release notes.
- The command palette can open the docs, the tool reference, the website
and GitHub.
- Info popovers are fixed: inline code and bold text no longer break
onto their own lines. They now have paragraph spacing and a "Read the
docs" link.
- New explainers were added across Overview, Websites, Vault, Vault log,
System (tokens, configuration, storage, migrations, degradations) and
session details.
- System setting hints now use the real camelCase flags
(`--maxSessions`, `--allowEvaluate`, `--retentionDays`) and link to each
key in the configuration reference.
## @browserhive/core@0.1.3

### Patch Changes

- Updated dependencies []:
  - @browserhive/contracts@0.1.3
## @browserhive/dashboard@0.1.3

### Patch Changes

- Updated dependencies []:
  - @browserhive/contracts@0.1.3
## @browserhive/contracts@0.1.3

No changes in this release.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
arg1998 added a commit that referenced this pull request Sep 23, 2026
- 03 §7: the reserved notification_channels, proxies, profiles,
  security_rules and extensions tables were never created; only logs and
  resource_samples exist. The comment now says which is which.
- 03 §9: notifications go to one shared inbox (principal_id NULL), not per
  operator; the recipients hook is the seam, unset by composition.
- 04 §13: touch is forwarded as raw touch events, not translated into wheel
  and right-click gestures.
- 04 §11/§16: the dashboard does link to browserhive.ai (since #13); the
  stale 'no links to a documentation site' limitation is replaced, and the
  live-view limits an operator actually hits are listed (no POST /sessions,
  agent-initiated takeover only, no clipboard or IME, popups never watched,
  no passkeys).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant