Skip to content

πŸ“– Dashboard UI map, docs-site help links and a Settings entry per tab - #19201

Merged
hivecommons-hive[bot] merged 4 commits into
v5from
docs/ask-help-ui-map
Nov 19, 2026
Merged

hivecommons-hive[bot] merged 4 commits into
v5from
docs/ask-help-ui-map

Conversation

@clubanderson

@clubanderson clubanderson commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

Docs coverage for the dashboard Ask AI help (phase 3 of the design in src/docs/design/dashboard-ask-ai-help.md).

What changes

  • New page: src/docs/dashboard-ui-map.md. How to sign in to the hosted hub, a hosted hive dashboard and a self-hosted dashboard (the area Kapa answered poorly), a table of common actions ("add a repository", "pause an agent", "open Settings"), and generated tables of the sidebar entries, the Settings tabs and the per-agent tabs with their on-screen labels.
  • Generator: src/pkg/dashboard/uimap/render-dashboard-ui-map.py (kept out of src/scripts, whose tree is pinned for the governance verifier). Reads static-src/html/sidebar.html, DASHBOARD_SECTION_HELP in sections.js and the tab lists in config-state.js, and rewrites only the text between the markers. --check runs in the docs link workflow, so a renamed section or tab fails CI until the page is regenerated.
  • Help links. dashboardDocsHref opens https://docs.hivecommons.dev/docs/hive/<page> on the v5 line for pages the docs site publishes today (each checked for HTTP 200 and matching heading anchors), and keeps GitHub for the rest and for other release lines, since the site follows v5 only. Same edit in static-src/js/sections.js and the committed static/index.html. New dashboard_docs_href.test.js covers the four cases.
  • settings.md gets an entry for every Settings tab that had none (Appearance, Agents, Workflows, Inbox, Project Observability, Meetings, Forge App, Bob, Variables), and both settings.md and dashboard-sections.md link the UI map.
  • Design record: a status subsection records what was re-checked against the docs repo, that the vendor does offer per-source URL and selector exclusions (this settles an earlier unverified note), and the vendor-side checklist status.

Companion change

The docs site PR in hivecommons/docs publishes dashboard.md, settings.md, hosted-hub.md, hub-deployment.md and telemetry.md (all were on its deliberate-omission list) and marks design records so the vendor can exclude them. After this PR merges, the docs site's scheduled refresh picks up dashboard-ui-map.md because synced pages link to it; once those pages are live they can be added to the docs-site list in dashboardDocsHref.

Checks

check-docs-links.py src/docs and check-docs-citations.py src/docs pass locally; render-dashboard-ui-map.py --check is up to date. No local build or tests were run.

What remains on #19182

The Ask-specific telemetry and consent wording waits for phases 1 and 2, and two vendor-side source exclusions (ADR URL prefix, design-record selector) are for the project owner.

Refs #19182

…s entry per tab

Add src/docs/dashboard-ui-map.md with sign-in steps for each kind of
dashboard, common actions, and sidebar and Settings tables generated from
the dashboard source by src/scripts/render-dashboard-ui-map.py (checked in
the docs link workflow). Point v5 help links at docs.hivecommons.dev for
pages the docs site publishes. Add the missing Settings tab entries and
record the Kapa-side checklist status in the Ask AI design.

Refs #19182

Signed-off-by: Andy Anderson <andy@clubanderson.com>
@kubestellar-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kellyaa for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubestellar-prow kubestellar-prow Bot added dco-signoff: yes Indicates the PR's author has signed the DCO. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 19, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Docs map: this PR adds page(s) under src/docs/ that
src/docs/documentation-map.md does not link:

  • dashboard-ui-map.md

A page missing from the map is one readers do not find. Please add a
line in the section a reader would actually look in, matching the
format of its neighbours.

If the page is indexed from a subdirectory README, or is deliberately
unlisted for now, ignore this. It is a reminder, not a gate; it never
blocks a merge.

@github-actions

github-actions Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Open PR overlap check

Base branch: v5

Conflicts are checked with every PR merged onto the current tip of v5, so a PR that only needs a rebase is not reported as conflicting with its siblings.

PR Title Relation Files
#19204 ✨ ask: hive backend and hub relay for optional Ask AI help same files src/docs/settings.md
src/pkg/dashboard/static/index.html
#19199 ✨ ask: hub backend for optional Ask AI help (phase 1) same files src/docs/design/dashboard-ask-ai-help.md
#19143 πŸ› Reviewer-stated rules: ignore quotes and questions, match more future phrasings, and give the preferences a Settings card same files src/docs/settings.md
src/pkg/dashboard/static/index.html
#19192 πŸ“– docs: prepare Ask AI dashboard help coverage CONFLICT src/docs/dashboard-ui-map.md (conflict)
src/docs/design/dashboard-ask-ai-help.md
src/docs/settings.md

@github-actions github-actions Bot added the conflicts-with-open-pr Open PR has a merge conflict with another open PR label Nov 19, 2026
@github-actions

github-actions Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

UI render evidence

Render evidence captured.

Built from c30223680d9d.
Screenshots: download the artifact (sign-in to GitHub required).
Run: https://github.com/hivecommons/hive/actions/runs/44442916432

Page Section Viewport Theme File Size
hive overview desktop light hive-overview-desktop-light.png 326 KB
hive overview desktop dark hive-overview-desktop-dark.png 307 KB
hive overview phone light hive-overview-phone-light.png 467 KB
hive overview phone dark hive-overview-phone-dark.png 464 KB
hub-fleet overview desktop light hub-fleet-overview-desktop-light.png 113 KB
hub-fleet overview desktop dark hub-fleet-overview-desktop-dark.png 115 KB
hub-fleet overview phone light hub-fleet-overview-phone-light.png 265 KB
hub-fleet overview phone dark hub-fleet-overview-phone-dark.png 270 KB
hub-dashboard overview desktop light hub-dashboard-overview-desktop-light.png 338 KB
hub-dashboard overview desktop dark hub-dashboard-overview-desktop-dark.png 344 KB
hub-dashboard overview phone light hub-dashboard-overview-phone-light.png 624 KB
hub-dashboard overview phone dark hub-dashboard-overview-phone-dark.png 656 KB

These are fixture renders, not live data: the page was built from the PR head and filled with synthetic data from src/scripts/fixtures/render-evidence/. They show layout and theming, not how real hives behave. How to read them: src/docs/ui-render-evidence.md.

@clubanderson

Copy link
Copy Markdown
Member Author

Overlap note: #19192 (opened earlier for the same issue) also adds src/docs/dashboard-ui-map.md with a Go generator wired into make dashboard-gen, plus Ask telemetry and consent wording and a Kapa checklist. The two UI map pages will conflict, so maintainers should pick one generator and page. Parts of this PR that #19192 does not cover: v5 help links to docs.hivecommons.dev in dashboardDocsHref (with dashboard_docs_href.test.js), a settings.md entry for every Settings tab, the sign-in section for hub, hosted and self-hosted dashboards, and the vendor checklist status (what is already done in Kapa). Those can be rebased onto #19192 if it lands first.

@hivecommons-hive

hivecommons-hive Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Hive status β€” updated in place; edits do not notify. Full history is in the Activity Monitor.

@clubanderson this PR is held at stage/071-needs-author and the hive will not merge it yet.

Failing checks:

  • runtime-tests

Next: the hive does not push to your branch. Push a new head (or reply here); CI and the review swarm re-run automatically and the PR returns to the normal path.

ℹ️ Sentinel: informational, author is trusted (owner), merge is not blocked. Head ea86c396f046 matched:

  • sensitive_path: changes 1 sensitive path(s) (.github/workflows/docs-link-check.yml)

No sentinel-alert label was added. The finding is recorded in the dashboard Security tab and /api/sentinel; set sentinel.trusted_authors_block: true to block trusted authors too.

Evidence bundle `#19201c302236` sha256:2fed3f0d310d982f7e768437a49b55350d156e9fec732bc9ce7624d5a2cc1def β€” download from the dashboard or `hivectl review evidence #19201`.

merged by Hive trusted-author auto-merge: author clubanderson holds role owner and GitHub permission admin on repo; CI green at c302236.

src/scripts is pinned by TRUSTED_SCRIPTS_TREE for the integration
governance verifier; a docs generator does not belong in that closure.

Refs #19182

Signed-off-by: Andy Anderson <andy@clubanderson.com>
@hivecommons-hive
hivecommons-hive Bot merged commit 8fea82b into v5 Nov 19, 2026
89 of 90 checks passed
@kubestellar-prow
kubestellar-prow Bot deleted the docs/ask-help-ui-map branch November 19, 2026 02:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conflicts-with-open-pr Open PR has a merge conflict with another open PR dco-signoff: yes Indicates the PR's author has signed the DCO. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant