DYN-9600 - Automatically synchronize the Documentation Browser to the currently selected node to reduce clicks, improve discoverability, and keep node help content aligned with user context. #16837
Conversation
…selected node. Add a toggle preference: Preferences >Features> Documentation Browser > Auto‑sync with node selection (default: On)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
See the ticket for this pull request: https://jira.autodesk.com/browse/DYN-9600
|
Build currently fails, please declare public APIs in |
| private Wpf.Utilities.ActionDebouncer delayDocumentBrowserRefresh | ||
| = new Wpf.Utilities.ActionDebouncer(null); | ||
| private int delayDocumentBrowserTime = 300; |
There was a problem hiding this comment.
curious to know why this was added? Did you see any side-effects/flickering/lag that was resolved by this?
There was a problem hiding this comment.
It was mentioned in the task description to add a debouncer to avoid flickering during rapid selection of nodes.
After removing Debouncer, I do not find any issues with manual testing. I have used the same delay time value used for DelayNodePreviewControl.
@zeusongit Let me know if you want me to remove that.
| /// - When Multiple nodes or a group selected: Do not change content; retain the last viewed help | ||
| /// - No selection: Retain the last viewed help. | ||
| /// - If a selected node is deleted or becomes invalid, retain last help and clear pause state if needed. | ||
| /// - Switching workspaces or graphs preserves the last help state per workspace session. |
There was a problem hiding this comment.
Does that mean it will update when switching to custom node workspace?
There was a problem hiding this comment.
No, we do not preserve the last selected node for each workspace. So DocumentExtensionBrowser content will not update.
This functionality works only when a node is selected in Workspace.
Renamed delayDocumentBrowserTime variable to delayDocumentBrowserRefreshTime
Added public properties and methods to PublicAPI.Unshipped.txt file. |
|
@CustomBuildingConfigurators-Balaji The selfserve job still fails because one of the test: TestImportCopySettings is failing |
…tion and TestImportCopySettings methods. Added IsAutoSyncDocumentBrowser value to DynamoSettings-NewSettings.xml
@zeusongit, Modified TestSettingsSerialization and TestImportCopySettings unit test methods with the newly added IsAutoSyncDocumentBrowser setting. |
2 participants
Purpose
DYN-9600
Implementation Scope (When the Node Help Documentation Browser is open and visible):
- When Single node selected: Change and display that new selected node’s help content automatically.
- When Multiple nodes or a group selected: Do not change content; retain the last viewed help.
- If a selected node is deleted or becomes invalid, retain last help and clear pause state if needed.
- Switching workspaces or graphs preserves the last help state per workspace session.
- Debounce the selection listener (used 300ms) to avoid flicker during rapid selection.
Declarations
Check these if you believe they are true
Reviewers
@reddyashish, @QilongTang
FYIs
@stevecbc