Upload of 9 node - in depth documentation#3309
Upload of 9 node - in depth documentation#3309stevecbc wants to merge 1 commit intoDynamoDS:masterfrom
Conversation
Dynamo node documentation
There was a problem hiding this comment.
Pull request overview
This PR adds/updates “In Depth” node help documentation and associated sample Dynamo graphs for several Revit, Translation, and DesignScript geometry nodes.
Changes:
- Added new fallback help markdown pages for
Dynamo.Translation.Models.ObjectFilter,Mesh.BoundingBox, andBoundingBox.ContextCoordinateSystem. - Updated fallback help markdown copy for several Revit revision/phase/performance-adviser selection nodes.
- Added/updated multiple NodeHelpFiles
.dynexample graphs and one new image asset.
Reviewed changes
Copilot reviewed 18 out of 27 changed files in this pull request and generated 19 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/Dynamo.Translation.Models.ObjectFilter.md | New in-depth help text and example image reference for ObjectFilter. |
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/DSRevitNodesUI.RevitRevisions.md | Updated in-depth help text for Select Revision. |
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/DSRevitNodesUI.RevitPhases.md | Updated in-depth help text for Select Phase. |
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/DSRevitNodesUI.RevisionVisibility.md | Updated in-depth help text for revision visibility selection. |
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/DSRevitNodesUI.RevisionNumberType.md | Updated in-depth help text for revision number type selection. |
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/DSRevitNodesUI.RevisionNumbering.md | Updated in-depth help text for revision numbering selection. |
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/DSRevitNodesUI.PerformanceAdviserRules.md | Updated in-depth help text for Performance Adviser rule selection. |
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/Autodesk.DesignScript.Geometry.Mesh.BoundingBox.md | New in-depth help text and example image reference for Mesh.BoundingBox. |
| doc/distrib/NodeHelpFiles/en-US/fallback_docs/Autodesk.DesignScript.Geometry.BoundingBox.ContextCoordinateSystem.md | New in-depth help text and example image reference for BoundingBox.ContextCoordinateSystem. |
| doc/distrib/NodeHelpFiles/Dynamo.Translation.Models.ObjectFilter.dyn | New/updated example graph for importing and filtering geometry file objects. |
| doc/distrib/NodeHelpFiles/DSRevitNodesUI.RevitRevisions.dyn | Updated example graph wiring around Select Revision and revision property nodes. |
| doc/distrib/NodeHelpFiles/DSRevitNodesUI.RevitRevisions_img.jpg | Added/updated example image for Select Revision. |
| doc/distrib/NodeHelpFiles/DSRevitNodesUI.RevitPhases.dyn | Updated example graph to place a family instance and set “Phase Created”. |
| doc/distrib/NodeHelpFiles/DSRevitNodesUI.RevisionVisibility.dyn | Updated example graph for creating a revision with visibility inputs. |
| doc/distrib/NodeHelpFiles/DSRevitNodesUI.RevisionNumberType.dyn | Updated example graph for creating a revision with number type inputs. |
| doc/distrib/NodeHelpFiles/DSRevitNodesUI.RevisionNumbering.dyn | Updated example graph for creating a revision with numbering inputs. |
| doc/distrib/NodeHelpFiles/DSRevitNodesUI.PerformanceAdviserRules.dyn | Updated example graph selecting multiple rules and executing them. |
| doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.Mesh.BoundingBox.dyn | New example graph generating mesh geometry and extracting bounding box min point. |
| doc/distrib/NodeHelpFiles/Autodesk.DesignScript.Geometry.BoundingBox.ContextCoordinateSystem.dyn | New example graph selecting a Revit element, computing a bounding box, and extracting the context coordinate system origin. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,310 @@ | |||
| { | |||
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |||
There was a problem hiding this comment.
The graph UUID is duplicated across multiple help .dyn files in this PR (e.g., several files now use c25c8fb0-e921-49d8-9fb6-501daff4f3a2). Dynamo graphs should have a unique Uuid per file; please restore/regenerate a unique UUID for this graph to avoid collisions in tooling that indexes graphs by UUID.
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |
| "Uuid": "7f4b4d1f-1ec3-4d94-a8f7-1a5bbf6f8a61", |
| "HintPath": "C:\\Users\\Steve\\Downloads\\North Arrows.dwg", | ||
| "InputValue": "..\\..\\..\\Downloads\\North Arrows.dwg" |
There was a problem hiding this comment.
This help graph hard-codes a user-specific absolute HintPath and a relative path into a local Downloads folder. Help graphs should be portable; consider removing HintPath/InputValue defaults or pointing to a repo-relative sample file that is actually included with the documentation assets.
| "HintPath": "C:\\Users\\Steve\\Downloads\\North Arrows.dwg", | |
| "InputValue": "..\\..\\..\\Downloads\\North Arrows.dwg" | |
| "HintPath": "", | |
| "InputValue": "" |
| "Name": "DynamoATF", | ||
| "Version": "26.0.2.0", | ||
| "ReferenceType": "Package", | ||
| "Nodes": [ | ||
| "f6d8cdce1e19440890fc338a9d9cc45c", | ||
| "52c8feaca9964062a364c5aca4ad0830", | ||
| "2e6bf907d48d45a2800024924b50c368", | ||
| "11303b943f934f9ca266b8a3f96af5a3" | ||
| ] | ||
| }, | ||
| { |
There was a problem hiding this comment.
NodeLibraryDependencies lists DynamoATF as a required package. DynamoATF is typically an internal test/automation package and may not be installed for end users, which would make this help graph fail to load/run. Please ensure the graph only depends on built-in libraries (or a publicly distributed package that ships with Dynamo) for node help content.
| "Name": "DynamoATF", | |
| "Version": "26.0.2.0", | |
| "ReferenceType": "Package", | |
| "Nodes": [ | |
| "f6d8cdce1e19440890fc338a9d9cc45c", | |
| "52c8feaca9964062a364c5aca4ad0830", | |
| "2e6bf907d48d45a2800024924b50c368", | |
| "11303b943f934f9ca266b8a3f96af5a3" | |
| ] | |
| }, | |
| { |
| }, | ||
| { | ||
| "Name": "North Arrows.dwg", | ||
| "ReferenceType": "External", | ||
| "Nodes": [ | ||
| "25636a6c700d4c86b896cbbfd493d8e5" | ||
| ] |
There was a problem hiding this comment.
NodeLibraryDependencies declares an external dependency on North Arrows.dwg, but that file does not appear to be part of the repository’s NodeHelpFiles assets. This will break portability of the help graph. Either include the DWG under version control in an appropriate location and reference it relatively, or remove the external dependency and rely on the user selecting their own file at runtime.
| }, | |
| { | |
| "Name": "North Arrows.dwg", | |
| "ReferenceType": "External", | |
| "Nodes": [ | |
| "25636a6c700d4c86b896cbbfd493d8e5" | |
| ] |
| ## In Depth | ||
| This node provides filtering rules for objects being processed between systems. | ||
|
|
||
| In this example, the North Arrows.dwg file is imported into Dynamo and Filter Geometry File Objects is used to customize the search only showing LayerID = 13. The last node displays all object with those properties. |
There was a problem hiding this comment.
Minor grammar issue: “displays all object” should be “displays all objects”. Also consider tightening spacing to a single space after periods for consistency/readability.
| In this example, the North Arrows.dwg file is imported into Dynamo and Filter Geometry File Objects is used to customize the search only showing LayerID = 13. The last node displays all object with those properties. | |
| In this example, the North Arrows.dwg file is imported into Dynamo and Filter Geometry File Objects is used to customize the search only showing LayerID = 13. The last node displays all objects with those properties. |
| @@ -1,5 +1,5 @@ | |||
| { | |||
| "Uuid": "49c5d9e7-9f4d-457b-bfe9-da9b88da959a", | |||
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |||
There was a problem hiding this comment.
The graph UUID is duplicated across multiple help .dyn files in this PR (many files now use c25c8fb0-e921-49d8-9fb6-501daff4f3a2). Dynamo graphs should have a unique Uuid per file; please restore/regenerate a unique UUID for this graph to avoid collisions.
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |
| "Uuid": "8c9c6d5b-8c3e-4b6a-9d8f-2e4f6a7b1c23", |
| @@ -1,5 +1,5 @@ | |||
| { | |||
| "Uuid": "49c5d9e7-9f4d-457b-bfe9-da9b88da959a", | |||
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |||
There was a problem hiding this comment.
The graph UUID is duplicated across multiple help .dyn files in this PR (many files now use c25c8fb0-e921-49d8-9fb6-501daff4f3a2). Dynamo graphs should have a unique Uuid per file; please restore/regenerate a unique UUID for this graph to avoid collisions.
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |
| "Uuid": "8d3e6d7d-3b3f-4d7d-bf0f-9dd4f8f7c3a1", |
| @@ -1,125 +1,21 @@ | |||
| { | |||
| "Uuid": "8fc33d2e-0479-479c-af1b-32dabbdb39bc", | |||
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |||
There was a problem hiding this comment.
The graph UUID is duplicated across multiple help .dyn files in this PR (many files now use c25c8fb0-e921-49d8-9fb6-501daff4f3a2). Dynamo graphs should have a unique Uuid per file; please restore/regenerate a unique UUID for this graph to avoid collisions.
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |
| "Uuid": "5b9d0d3c-6c1c-4b39-9f3d-8d9d3c3c6f21", |
| "IsVisibleInDynamoLibrary": true, | ||
| "Version": "3.4.1.7055", | ||
| "RunType": "Manual", | ||
| "RunType": "Automatic", |
There was a problem hiding this comment.
This help graph is set to RunType: "Automatic". Since it executes Performance Adviser rules (which can be expensive and may surface many failures), running automatically on open can be disruptive. Consider switching back to Manual run mode for node help graphs that trigger model analysis/execution.
| "RunType": "Automatic", | |
| "RunType": "Manual", |
| @@ -0,0 +1,636 @@ | |||
| { | |||
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |||
There was a problem hiding this comment.
The graph UUID is duplicated across multiple help .dyn files in this PR (many files now use c25c8fb0-e921-49d8-9fb6-501daff4f3a2). Dynamo graphs should have a unique Uuid per file; please restore/regenerate a unique UUID for this graph to avoid collisions.
| "Uuid": "c25c8fb0-e921-49d8-9fb6-501daff4f3a2", | |
| "Uuid": "9d7b5f5d-4d67-4f6e-b108-f1e2dded6f4a", |
Dynamo node documentation
Please Note:
DynamoRevitrepo will need to be cherry-picked into all the DynamoRevit Release branches that Dynamo supports. Contributors will be responsible for cherry-picking their reviewed commits to the other branches after aLGTMlabel is added to the PR.Purpose
(FILL ME IN) This section describes why this PR is here. Usually it would include a reference
to the tracking task that it is part or all of the solution for.
Declarations
Check these if you believe they are true
*.resxfilesReviewers
(FILL ME IN) Reviewer 1 (If possible, assign the Reviewer for the PR)
(FILL ME IN, optional) Any additional notes to reviewers or testers.
FYIs
(FILL ME IN, Optional) Names of anyone else you wish to be notified of