Skip to content

docs(dash): correct stale module comments in the dashboard crates - #978

Merged
jussielo-amd merged 3 commits into
mainfrom
worktree-fix-972-stale-dash-comments
Nov 9, 2026
Merged

jussielo-amd merged 3 commits into
mainfrom
worktree-fix-972-stale-dash-comments

Conversation

@jussielo-amd

@jussielo-amd jussielo-amd commented Nov 9, 2026 •

Copy link
Copy Markdown
Collaborator

Closes #972.

Corrects module-level comments in the dashboard crates that said things the code or the repository does not bear out. The change is comment-only: no code changes, and the only non-Rust file touched is one comment in a Cargo.toml. The one visible effect is the --help text of the two rocm-dash-tui examples, whose clap doc comments were corrected.

What changed

  • Missing wiki/ pointers. Dropped the ../wiki/... references from the 13 files the issue lists. A fourteenth, vllm_log.rs, carried the same pointer and was edited here too, but main deleted that file as unused code in docs: map every production source file and empty EXEMPT #965 while this PR was open, so its edit is gone with it. No wiki/ directory exists, so each sentence keeps whatever else it said. protocol.rs, theme.rs and lib.rs no longer lean on the pointer.
  • Commands that do not exist. demo.rs and the two examples named rocm gen-demo, rocm demo, rocm replay and make demo, and default paths under marketing/ and app/, none of which exist. They now name rocm dash --demo / --replay and say what the session file is. The examples' docs now also say their output is marked as simulated data, which the code does whatever the input is.
  • Comments that no longer match the code. bench_rollup.rs (the real RollupKey, including that a missing engine is its own group), rocm-deps (consumers are rocm and the Lemonade engine, not the dashboard TUI), the collectors Cargo.toml (rocm-core is also a normal dependency), parallel.rs (the daemon runner calls parallel_scrape), model_picker.rs (the preferred engine is shown, never applied), tabs/chat.rs, tabs/pane.rs (no RocmToolExecutor on that path), tabs/home.rs (Home is the default tab) and lib.rs.
  • "Phase N Wave N" labels removed from the titles of the dash TUI source module headers, together with the sentences that leaned on them, and a pointer in approval.rs to a working-agreements document that is not in the repository.

How it was checked

Each claim was re-read against the code before editing. The diff contains no non-comment line. Before merging main, cargo clippy --all-targets -- -D warnings, cargo doc and cargo test passed for rocm-dash-core, rocm-dash-collectors, rocm-dash-tui, rocm-dash-daemon and rocm-deps (1508 tests), and the pre-push hooks passed. After merging main into the branch, I re-ran cargo fmt --check, cargo clippy --all-targets -- -D warnings on those five crates, cargo test for rocm-dash-tui and rocm-dash-collectors (1262 passed, 6 ignored), cargo doc for the same two, and cargo xtask check-architecture-doc; all pass. The pre-push hooks were not re-run for the merge commit, and I re-checked that no wiki/ pointer and no rocm gen-demo, make demo or marketing/ mention was added on main in these crates since this branch started (the only marketing/ mentions left are the two example defaults below). A review of the diff by a separate reviewer found four things that were wrong in the first version of this change (a --persist-dir flag that is only a comment, Wave-0 sentences left behind in six headers, a recommendation to use the unused WarningBus, and an over-absolute reducer claim); those are fixed here. The fixes were not reviewed a second time.

No Gherkin scenario is added: nothing a CLI user observes changes, so there is no behavior for a scenario to cover. A unit test for a comment would only pin the string.

Overlap with #371

#371 (approved, currently conflicting with main) removes the same kind of doc pointers in 15 of the files touched here and adds a cargo xtask verify-doc-paths gate; this PR does not add a gate. Whichever lands second needs a rebase. If #371 goes first, I can drop the overlapping hunks from this PR.

Not in this PR

  • The collectors' [dev-dependencies] entry for rocm-core is redundant now that it is a normal dependency. Only its comment is corrected here, to keep this change comment-only.
  • The --input and output defaults of the two examples (../marketing/..., /tmp/mi355x-demo.ndjson) still point at things that do not exist. That is a code change, done in the follow-up fix(dash): drop stale default paths from the gen_cast and gen_screenshots examples #984, which is stacked on this PR.
  • bench_rollup's grouping rule is documented here but no test varies engine.
  • persist.rs and server.rs still mention a --persist-dir flag that does not exist, and a number of Phase/Wave mentions remain in item comments and in tests/.

Module-level comments in the dashboard crates described things that are not
true of the code or the repository. None affects behavior.

- Drop the pointers to a wiki/ directory the repository does not have (14
  files), keeping the one sentence in each that still carries information.
- demo.rs and the two examples named rocm gen-demo, rocm demo, rocm replay and
  make demo, none of which exist, and default paths under marketing/ and app/.
  They now name rocm dash --demo / --replay and the session file format.
- bench_rollup, rocm-deps, the collectors Cargo.toml, parallel.rs, lib.rs,
  model_picker, chat, pane and home described a key, a consumer set, a
  dependency edge, a call path, a tab default or a phase that no longer matches
  the code.
- Remove "Phase N Wave N" labels from the titles of the dash TUI source module
  headers, together with the sentences that leaned on them, and the pointer to
  a working-agreements document that is not in the repository.

Comment-only change.

Fixes #972

Signed-off-by: Jussi Elo <jussi.elo@amd.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain to block approval of the documentation updates.

No open issues 🎉

What changed in this PR

Addresses #972 by aligning dashboard module documentation with the current codebase. Changes are comment-only, though corrected clap doc comments also update the two examples’ --help text.

Changes:

  • Removes nonexistent documentation pointers and obsolete Phase/Wave labels.
  • Corrects descriptions of benchmark grouping, dependencies, collector execution, and dashboard UI behavior.
  • Updates demo and rendering-example documentation to describe existing commands and recording formats.
File Description
crates/​rocm-deps/​src/​lib.rs Corrects the list of dependency-pin consumers.
crates/​rocm-dash-tui/​src/​ui/​update_manager.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​theme.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-tui/​src/​ui/​tabs/​pane.rs Corrects the documented action-to-overlay flow.
crates/​rocm-dash-tui/​src/​ui/​tabs/​home.rs Identifies Home as the default tab.
crates/​rocm-dash-tui/​src/​ui/​tabs/​chat.rs Describes the current consent gate and chat backend.
crates/​rocm-dash-tui/​src/​ui/​services_manager.rs Replaces historical rollout wording with current behavior.
crates/​rocm-dash-tui/​src/​ui/​serve_wizard.rs Removes obsolete phase and primitive labels.
crates/​rocm-dash-tui/​src/​ui/​runtime_manager.rs Removes obsolete phase and folder-browser labels.
crates/​rocm-dash-tui/​src/​ui/​onboarding.rs Describes onboarding without historical phase references.
crates/​rocm-dash-tui/​src/​ui/​model_picker.rs Clarifies that preferred engines are displayed, not applied.
crates/​rocm-dash-tui/​src/​ui/​logs_view.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​job_console.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​install_manager.rs Removes obsolete phase and folder-browser labels.
crates/​rocm-dash-tui/​src/​ui/​folder_browser.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​exec.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​examine_manager.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​engine_manager.rs Replaces rollout history with current integration details.
crates/​rocm-dash-tui/​src/​ui/​dock.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​config_manager.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​command_screen.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​automations_manager.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​src/​ui/​approval.rs Removes a phase label and missing-document citation.
crates/​rocm-dash-tui/​src/​tool_exec.rs Describes the existing execution paths without phase history.
crates/​rocm-dash-tui/​src/​llm.rs Removes the agent’s obsolete phase reference.
crates/​rocm-dash-tui/​src/​jobs.rs Removes the obsolete phase label.
crates/​rocm-dash-tui/​examples/​gen_screenshots.rs Corrects usage, recording-format documentation, and argument help.
crates/​rocm-dash-tui/​examples/​gen_cast.rs Corrects usage, recording-format documentation, and argument help.
crates/​rocm-dash-daemon/​src/​demo.rs Documents the actual demo generation and replay commands.
crates/​rocm-dash-core/​src/​vram.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-core/​src/​state.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-core/​src/​protocol.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-core/​src/​partition.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-core/​src/​metrics.rs Removes nonexistent wiki pointers.
crates/​rocm-dash-core/​src/​lib.rs Replaces a missing citation with a reducer description.
crates/​rocm-dash-core/​src/​efficiency.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-core/​src/​bench_schema.rs Removes nonexistent wiki pointers.
crates/​rocm-dash-core/​src/​bench_rollup.rs Documents the actual grouping key and missing-engine behavior.
crates/​rocm-dash-collectors/​src/​vllm_prom.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-collectors/​src/​vllm_log.rs Removes nonexistent wiki pointers.
crates/​rocm-dash-collectors/​src/​parallel.rs Documents the runner’s use of parallel_scrape.
crates/​rocm-dash-collectors/​src/​docker.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-collectors/​src/​amd_smi.rs Removes a nonexistent wiki pointer.
crates/​rocm-dash-collectors/​Cargo.toml Corrects the comment about the existing rocm-core dependency.

Review effort: Balanced

@jussielo-amd
jussielo-amd marked this pull request as ready for review November 9, 2026 12:01
@jussielo-amd
jussielo-amd requested a review from a team as a code owner November 9, 2026 12:01

@juhovainio juhovainio left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Approving: comment-only change, and I checked each corrected comment against the code at this head; they are accurate. CI is green apart from the GPU/Strix lanes that are skipped for lack of runners.

Two non-blocking notes, left as inline comments:

  • serve_wizard.rs: the rewritten header line is long and could be rewrapped.
  • gen_cast.rs / gen_screenshots.rs: the corrected help text is accurate, but the default paths (../marketing/..., /tmp/mi355x-demo.ndjson) still point at things that do not exist. That is a code change, so a follow-up.

The rewritten header line ran to about 120 columns; rewrap it to match the
surrounding `//!` lines.

Signed-off-by: Jussi Elo <jussi.elo@amd.com>

@nowycondro nowycondro left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 Automated review · review-code · head 66c7a19f0e5

Outcome: no blocking findings. This is a comment-only documentation fix (mechanically confirmed: every changed line in the touched .rs files is a // doc comment; the one non-Rust hunk, in rocm-dash-collectors/Cargo.toml, is also comment-only). It closes #972, and every item listed in that issue (the dead wiki/ pointers, the nonexistent rocm gen-demo/rocm demo/rocm replay/make demo references, the bench_rollup.rs grouping-key claim, the rocm-deps consumer list, the collectors Cargo.toml comment, parallel.rs, model_picker.rs, tabs/chat.rs, tabs/pane.rs, tabs/home.rs, and the stale "Phase N Wave N" labels) is addressed in the diff.

Verification performed: split the 44 changed files into coupled groups and independently checked every new/rephrased factual claim against the actual code (not just taken on the comment's word), plus a dedicated agent-instruction-adherence pass and a history/prior-PR pass. Specifically confirmed, among others: RollupKey is really (cell, model, engine, tp, dtype, concurrency) and a blank engine doesn't group with a populated one; ChatConsent really gates the chat tab; ActiveTab::Home is really #[default]; apply_action (in app/actions.rs) really owns the KeyAction::Open* path with no RocmToolExecutor involved; rocm-deps's real consumers are the rocm binary and the Lemonade engine adapter, not the dashboard TUI; rocm dash --demo/--replay and generate_file are real and behave as described. No case was found where a "corrected" comment is itself wrong, overstated, or drops something materially important. CI on this commit is green (all required checks SUCCESS; GPU/Strix E2E lanes SKIPPED for lack of runners, consistent with the PR's own description).

Non-blocking / decisions for the author (not new — already surfaced in the PR's own description or by the existing human review):

  • Overlap with open PR #371, which touches 15 of the same files (including the same bench_rollup.rs fix) and adds a cargo xtask verify-doc-paths CI gate this PR does not add. The author already flagged this tradeoff and said whichever lands second needs a rebase — independently re-confirmed via the repo's history/PR search, nothing new to add here.
  • The already-noted (by human review) stale default paths in gen_cast.rs/gen_screenshots.rs (/tmp/mi355x-demo.ndjson, ../marketing/...) still point at nonexistent locations; this is out of scope for a comment-only change and both examples fail cleanly (via anyhow::Result) rather than silently misbehaving on a missing default input.

What this covered: full diff between the merge-base and the reviewed head, all 44 files read completely (not just hunks) by independent passes, plus agent-instruction (AGENTS.md) and git-history/prior-PR checks. Not reconciled against the PR's review-comment threads.


Not a human review. This is an automated code review; please verify findings independently before acting on them.

Main deleted crates/rocm-dash-collectors/src/vllm_log.rs (#965, an unused
module), which this branch had edited to drop a wiki pointer from its module
comment. The deletion stands: the file's comment fix is moot, so the branch
now drops the pointer from the thirteen files the issue lists.

Signed-off-by: Jussi Elo <jussi.elo@amd.com>
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Caution

3 potential secret finding(s) were committed in this pull request. Treat each credential as compromised and revoke or rotate it now, even if a later commit removed it. Deleting the line or force-pushing does not undo the leak: the commits stay reachable from this pull request and from every clone or fork, and automated scanners harvest secrets pushed to public repositories within minutes.

If a finding is a test fixture or a false positive, allowlist it in the configuration of the scanner that reported it.

Security scan found 3 critical or high finding(s) on lines changed by this pull request
Scanner Severity Rule Location Finding
Gitleaks HIGH generic-api-key apps/rocm/src/runtime_install_finalize.rs:1315 Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
Gitleaks HIGH generic-api-key apps/rocm/src/serve_summary.rs:521 Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
Gitleaks HIGH generic-api-key apps/rocm/src/serve_summary.rs:549 Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

View the security scan run for complete reports.

“New” means the finding is located in a changed file on an added or modified line; it is not a base-versus-head findings delta.

@jussielo-amd
jussielo-amd added this pull request to the merge queue Nov 9, 2026
Merged via the queue into main with commit 7da776c Nov 9, 2026
45 of 48 checks passed
@jussielo-amd
jussielo-amd deleted the worktree-fix-972-stale-dash-comments branch November 9, 2026 20:47
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.

dashboard crates: stale module comments (missing wiki links, nonexistent commands, wrong keys)

4 participants