Skip to content

Collection Settings: Help button for the page showing (BL-17032) - #8489

Merged
StephenMcConnel merged 1 commit into
masterfrom
BL-17032-settings-help-2
Oct 23, 2026
Merged

StephenMcConnel merged 1 commit into
masterfrom
BL-17032-settings-help-2

Conversation

@andrew-polk

@andrew-polk andrew-polk commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Problem

The new (React) Collection Settings dialog has no Help button. The old WinForms dialog opened a help topic for the tab showing. Config-R, which draws the dialog's pages, could not tell the dialog which page was showing, and could not switch pages while the dialog stayed open.

Fix

  • Config-R (feat: report the showing top-level page, and select one through a ref sillsdev/config-r#29): ConfigrPane gains onTopLevelPageChange, which reports the showing page's key, and selectedTopLevelPageKey, which switches to a page while the pane stays mounted, keeping the user's edits. initiallySelectedTopLevelPageKey works as before. BL-16734 will use the switch to replace its paneRemount workaround.
  • Bloom: a Help button at the left of the dialog's bottom bar opens the topic for the showing page. Languages, Front & Back Matter and Subscription keep the old dialog's topics for those settings. Team Collection, Bloom Library, Advanced and Experimental get the general Settings topic.

Screenshots

The dialog's bottom bar, with Help at the left:

The bottom bar: Help at the left, OK and Cancel at the right

After a change that needs a restart, the restart message sits after Help, and OK reads Restart:

The bottom bar after renaming the collection: Help, the restart message, Restart and Cancel

Risk Evaluation

Low. The change only reaches the new Collection Settings dialog, which is still being built alongside Old Settings. The bottom-left group now always has Help in it, and the restart message moved into the same group after it.

Not caused here, but now easy to reach: Bloom's existing help request never replies. After about six Help presses in one session, help stops changing topic and other requests stall too (for example OK no longer relabels to Restart). Every React Help button has this; it is tracked as BL-17033.

Ecosystem Impact

  • Moves to @sillsdev/config-r 1.0.0-alpha.30 (from alpha.29). That release only adds to Config-R's API, so nothing else that uses it changes.
  • No new strings: the button uses the existing Common.Help.
  • No effect on books, published output, or other repos.

E2E Coverage

  • New collection-settings-help.spec.ts: opens the dialog, shows each of the seven pages, clicks Help, and checks which topic Bloom was asked for. The test answers the help request itself, so no help window opens.
  • Not covered: that each help topic exists in the help file and shows. The test checks only that the right topic is requested.

Notion Test Suite

Preflight report: https://bloombooks.github.io/dev-process-artifacts/deciders/bloomdesktop-bl-17032-settings-help-2.html

Ref: https://issues.bloomlibrary.org/youtrack/issue/BL-17032

🤖 Generated with Claude Code

Devin review


This change is Reviewable

Comment thread src/BloomBrowserUI/collection/CollectionSettingsDialog.tsx
@andrew-polk

Copy link
Copy Markdown
Contributor Author

[Claude Opus 5.5 from Andrew Polk's machine during preflight] Consulted Devin on 2026-10-20 up to commit 244df74. One finding, the unpublished Config-R version, is open on its thread until 1.0.0-alpha.30 is in.

Base automatically changed from BL-16736-bloom-library-collection-settings to master October 21, 2026 19:30
@andrew-polk
andrew-polk added this pull request to stack #8498 October 23, 2026 16:07
@andrew-polk

Copy link
Copy Markdown
Contributor Author

[Claude Opus 5.5 from Andrew Polk's machine during preflight] Consulted Devin on 2026-10-23 up to commit af22717. It repeated only the pinned-Config-R finding, which that commit already fixes (alpha.30); its thread is resolved.

@andrew-polk andrew-polk left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@andrew-polk reviewed 9 files and all commit messages, and resolved 1 discussion.
Reviewable status: 0 of 9 files reviewed, all discussions resolved.

The dialog's bottom bar gets a Help button that opens the help topic for the page showing. Config-R 1.0.0-alpha.30 reports that page (onTopLevelPageChange). Languages, Front & Back Matter and Subscription keep the old dialog's topics; the other pages use the general Settings topic. Adds unit tests for the topic choice, an e2e test that intercepts the help request, and notes in the plan.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@andrew-polk
andrew-polk force-pushed the BL-17032-settings-help-2 branch from af22717 to aa605ef Compare October 23, 2026 20:46
@andrew-polk
andrew-polk marked this pull request as ready for review October 23, 2026 20:47
@greptile-apps

greptile-apps Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in Greptile

[Low impact] The PR appears safe to merge; no actionable new issue was established.

Summary

Adds page-specific Help to the React Collection Settings dialog.

  • The Collection Settings dialog opens help for the page showing.

Tests and visual checks were not run. Config-R’s implementation was not installed locally, so its new callback behavior could not be checked directly.

Reviews (1) · Last reviewed commit: "Collection Settings: Help button for the..." · Reviewed by Greptile

@StephenMcConnel StephenMcConnel 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.

@StephenMcConnel reviewed 9 files and all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on andrew-polk).

@StephenMcConnel
StephenMcConnel merged commit 70c0106 into master Oct 23, 2026
3 checks passed
@StephenMcConnel
StephenMcConnel deleted the BL-17032-settings-help-2 branch October 23, 2026 21:02
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.

2 participants