Conversation
Introduce a debug-only RecordNodeHelpData command to capture node help artifacts. Implements RecordNodeHelpData in DynamoViewModel which validates a single selected node, computes a minimum qualified name, exports a workspace image (overlaying 3D background with graph), saves a sample .dyn, and generates a markdown (.md) help file. Temporary images are cleaned up and toast notifications report success/errors. Wire up the command (RecordNodeHelpDataCommand) in InitializeDelegateCommands and expose the DelegateCommand property, and add a corresponding menu item in DynamoView.xaml. Files are written to doc/distrib/NodeHelpFiles/en-US by default.
There was a problem hiding this comment.
Pull request overview
This PR adds a debug-only feature to Dynamo for capturing node help documentation artifacts. The feature allows developers to select a single node and automatically generate the three required files (markdown documentation, sample graph, and screenshot) needed for node help documentation.
Changes:
- Implements
RecordNodeHelpDatacommand in DynamoViewModel to validate selection, generate files using minimum qualified name, and provide user feedback - Adds command infrastructure by wiring up
RecordNodeHelpDataCommandinInitializeDelegateCommandsand exposing the DelegateCommand property - Adds a new menu item "Record Node Help Data" to the Debug menu in DynamoView.xaml
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| src/DynamoCoreWpf/Views/Core/DynamoView.xaml | Adds menu item for the new RecordNodeHelpData command in the Debug menu |
| src/DynamoCoreWpf/ViewModels/Core/DynamoViewModelDelegateCommands.cs | Registers RecordNodeHelpDataCommand and declares the DelegateCommand property |
| src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs | Implements core functionality to generate node help files (.md, .jpg, .dyn) with validation, image overlay, and file generation logic |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Question: Is there any way to make this not in a debug menu for broader use? I think this would be fantastic for the broader community, Eg. Package authors. |
I feel this would seem out of place outside the debug mode, maybe we can surface this and let package authors build Dynamo locally, to leverage this? |
|
I think I can probably modify the monocle code to use an invocation of this new mode? I think of Revit package authors. It is very difficult to build a debug build and load in Revit |
Purpose
Summary
Introduce a debug-only RecordNodeHelpData command to capture node help artifacts. Implements RecordNodeHelpData in DynamoViewModel which validates a single selected node, computes a minimum qualified name, exports a workspace image (overlaying 3D background with graph), saves a sample .dyn, and generates a markdown (.md) help file. Temporary images are cleaned up and toast notifications report success/errors. Wire up the command (RecordNodeHelpDataCommand) in InitializeDelegateCommands and expose the DelegateCommand property, and add a corresponding menu item in DynamoView.xaml. Files are written to doc/distrib/NodeHelpFiles/en-US by default.
Feature Details
When triggered, the feature:
{NodeName}.md- Markdown documentation with node description and image reference{NodeName}_img.jpg- Workspace screenshot with 3D background overlay{NodeName}.dyn- Current workspace saved as sample graphdoc/distrib/NodeHelpFiles/en-US/Declarations
Check these if you believe they are true
Release Notes
Add RecordNodeHelpData feature