DYN-9927: Template files

[Chloepeg]

Purpose

This pr addresses Jira task 9927 https://jira.autodesk.com/browse/DYN-9927
We have created 3 different templates for Dynamo.
A guide about how to create a standard Dynamo script
A workflow template for import and export workflow
A custom node and its guide.

Declarations

Check these if you believe they are true

• Is documented according to the standards
• The level of testing this PR includes is appropriate
• Changes to the API follow Semantic Versioning and are documented in the API Changes document.

Release Notes

-3 Dynamo template files
-1 Dynamo custom node file
-Ressource files for the templates

Reviewers

@johnpierson
@jnealb
@zeusongit

FYIs

@achintyabhat

[github-actions]

See the ticket for this pull request: https://jira.autodesk.com/browse/DYN-9927

[Copilot]

Pull request overview

This PR introduces template files for Dynamo to help users learn standard workflows and custom node creation. The templates include example files for geometry and CSV import/export, a custom node for curve validation, and supporting resource files.

Changes:

• Added three Dynamo template files demonstrating standard workflows
• Added a custom node (Curve_Validate.dyf) with comprehensive curve validation logic
• Added resource files (SAT geometry and CSV examples) to support the templates

Reviewed changes

Copilot reviewed 5 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
doc/distrib/templates/Geometry_Import_Example.sat	SAT geometry file for import workflow demonstration
doc/distrib/templates/Geometry_Export_Example.sat	SAT geometry file for export workflow demonstration
doc/distrib/templates/Curve_Validate.dyf	Custom node implementing curve validation with null checks, type validation, length tolerance, and closure rules
doc/distrib/templates/CSV_Import_Example.csv	CSV file with example data for import workflow
doc/distrib/templates/CSV_Export_Example	Text file with example export data

[johnpierson]

These look really nice. I have comments inline below on each file (some repeated).

But generally, we want to:

• Avoid the phrase script and use graph throughout. Unless we are referring to a python script or similar.
• Use Title casing throughout in headings.
• Remove the "Legal Notice" code block as this is not present on any other samples that are distributed. At this time it reads "This code may not be published or duplicated" which is the complete opposite of what a template is to be used for.

[johnpierson]

Graph Thumbnail

Export so it is a node only view. Examples are in the samples folder.

Nomenclature:

• Avoid use of word script throughout and change to "graph" in all occurences.

Title Case

• For proper titles, let's use Title Case Example "Script Name" instead of "Script name"

Template File Naming

Lets name Templates with a prefix so they sort in the browser.
Eg. Template_00_HowToCreateADynamoGraph

CamelCase is used throughout the samples, so lets stick with that instead of the _

Script Information change to "Graph Information"

• Author Code Block - change the email to DynamoTeam@autodesk.com

Let's also switch to using notes instead of open-ended code blocks. This results in outputs that exist in the graph and are unused, which is not a best practice. Example below:

2. Node Naming Standards

Change the "Typical do rules" and "Typical do not rules" to this:

`
/*
Do:
Rename key nodes only (inputs, rules, outputs, decision logic)
Use notes to add context to your script
Use capitalisation consistently (e.g. Title Case or camelCase, not mixed)
*/

/*
Do Not:
Rename every node in the graph
Leave important nodes with default names if they affect logic
Use vague names like "Data", "Stuff", "Fix", "Test"
*/;
`

[johnpierson]

Graph Thumbnail

Export so it is a node only view. Examples are in the samples folder.

Nomenclature:

• Avoid use of word script throughout and change to "graph" in all occurences.

Title Case

• For proper titles, let's use Title Case Example "Script Name" instead of "Script name"

Template File Naming

Lets name Templates with a prefix so they sort in the browser.
Eg. Template_01_ImportExportWorkflow

CamelCase is used throughout the samples, so let's stick with that instead of the _

Script Information change to "Graph Information"

• Author Code Block - change the email to DynamoTeam@autodesk.com

Let's also switch to using notes instead of open-ended code blocks. This results in outputs that exist in the graph and are unused, which is not a best practice. Example below:

[johnpierson]

Graph Thumbnail

Export so it is a node only view. Examples are in the samples folder.

Graph Bounds

There is a stray note in the way bottom left making the graph quite large.

Nomenclature:

• Avoid use of word script throughout and change to "graph" in all occurences.

Title Case

• For proper titles, let's use Title Case Example "Script Name" instead of "Script name"

Template File Naming

Lets name Templates with a prefix so they sort in the browser.
Eg. Template_03_CustomNodes

CamelCase is used throughout the samples, so let's stick with that instead of the _

Script Information change to "Graph Information"

• Author Code Block - change the email to DynamoTeam@autodesk.com

Let's also switch to using notes instead of open-ended code blocks. This results in outputs that exist in the graph and are unused, which is not a best practice. Example below:

[johnpierson]

i believe we all are set on this

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud