Skip to content

Batch 02 - Submit Node Help (14 nodes documented) #3203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

stevecbc
Copy link
Contributor

@stevecbc stevecbc commented Jul 23, 2025

In depth Node Documentation

Purpose

This PR adds comprehensive documentation for 14 Dynamo nodes by creating markdown files and accompanying example .dyn files. The documentation covers various Revit element operations including views, schedules, model curves, and family parameters with detailed explanations and practical examples.

Adds detailed node documentation with in-depth explanations and usage examples
Includes working Dynamo (.dyn) example files demonstrating each node's functionality
Covers diverse node categories: Views (sheets, sections, axonometric), Schedules, Model elements, and Family parameters
(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

  • The code base is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • Snapshot of UI changes, if any.

Reviewers

(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

In depth Node Documentation
@stevecbc stevecbc requested a review from achintyabhat July 23, 2025 14:36
@johnpierson johnpierson requested a review from Copilot July 23, 2025 14:36
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds comprehensive documentation for 14 Dynamo nodes by creating markdown files and accompanying example .dyn files. The documentation covers various Revit element operations including views, schedules, model curves, and family parameters with detailed explanations and practical examples.

  • Adds detailed node documentation with in-depth explanations and usage examples
  • Includes working Dynamo (.dyn) example files demonstrating each node's functionality
  • Covers diverse node categories: Views (sheets, sections, axonometric), Schedules, Model elements, and Family parameters

Reviewed Changes

Copilot reviewed 28 out of 42 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
Sheet.ByNameNumberTitleBlockAndViews.md Documents sheet creation with views placement functionality
SectionView.ByCoordinateSystemMinPointMaxPoint.md Documents section view creation using coordinate systems
SectionView.ByBoundingBox.md Documents section view creation from bounding boxes
ScheduleView.RemoveFields.md Documents schedule field removal functionality
ScheduleView.CreateAreaSchedule.md Documents area schedule creation process
ScheduleView.ClearAllFilters.md Documents schedule filter clearing functionality
AxonometricView.ByEyePointTargetAndElement.md Documents 3D view creation with element isolation
AxonometricView.ByEyePointAndTarget.md Documents basic 3D view creation
AreaPlanView.ByLevelAndAreaScheme.md Documents area plan view creation
ModelCurve.ByCurve.md Documents model line creation from curves
FamilyParameter.SpecType.md Documents family parameter type retrieval
DirectShape.ByMesh.md Documents DirectShape creation from mesh geometry
DetailCurve.Curve.md Documents detail line curve extraction
DetailCurve.ByCurve.md Documents detail line creation
Comments suppressed due to low confidence (2)

doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.FamilyParameter.SpecType.md:4

  • Multiple issues: Remove the comma after 'of', fix 'pre-defied' to 'pre-defined', remove extra spaces before 'The', and fix the apostrophe in 'its''. The sentence should read: 'In this example inputs of all element classes and a slider are used to select from a pre-defined list of unique elements. The slider is then used to select from these elements then view their SpecTypes. The two watch nodes at the end display the Element and its SpecType.'
In this example inputs of, all element classes and a slider are used to select from a pre-defied list of unique elements.  The slider is then used to select from these elements then view their SpecTypes.  The two watch nodes at the end display, the Element and its’ SpecType.

doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.DirectShape.ByMesh.md:4

  • Fix the apostrophe in 'its'' and remove extra spaces before sentences. The text should read: 'In this example, a family that has mesh geometry modeled is selected and used to extract its mesh and name to create a direct shape along with a category and material. Warnings will show if any of the selected elements are not in mesh format. See Object.Type node results for clarification on geometry types (Mesh, Solid).'
In this example, a family that has mesh geometry modeled is selected and used to extract its’ mesh and name to create a direct shape along with a category and material.  Warnings will show if any of the selected elements are not in mesh format.  See Object.Type node results for clarification on geometry types (Mesh, Solid).  

@Amoursol Amoursol changed the title submit Node help (14 nodes documented) Submit Node Help (14 nodes documented) Jul 23, 2025
@Amoursol Amoursol changed the title Submit Node Help (14 nodes documented) Batch 02 - Submit Node Help (14 nodes documented) Jul 23, 2025
stevecbc and others added 7 commits July 23, 2025 07:40
…iews.Sheet.ByNameNumberTitleBlockAndViews.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…iews.ScheduleView.RemoveFields.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…iews.ScheduleView.ClearAllFilters.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…iews.AxonometricView.ByEyePointAndTarget.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…iews.AreaPlanView.ByLevelAndAreaScheme.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…odelCurve.ByCurve.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…etailCurve.ByCurve.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Choose a reason for hiding this comment

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

@stevecbc Thank you for adding the note about the warnings-these kind of things help users :)

Choose a reason for hiding this comment

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

@stevecbc Love the finer details in this node help file, these nuances help users!

Choose a reason for hiding this comment

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

@stevecbc Monocle icons are seen in the image and the Point.ByCoordinates lower node has its node preview bubble (output) is cut off. Can we please fix this?

Choose a reason for hiding this comment

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

@stevecbc Same as above, Monocle icons are seen in the image. This is not OOTB and can confuse some users.

Choose a reason for hiding this comment

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

@stevecbc Same as above, Monocle icons are seen in the image. This is not OOTB and can confuse some users.

Choose a reason for hiding this comment

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

@stevecbc Same as above, Monocle icons are seen in the image. This is not OOTB and can confuse some users.

Choose a reason for hiding this comment

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

@stevecbc Same as above, Monocle icons are seen in the image. This is not OOTB and can confuse some users.

Choose a reason for hiding this comment

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

@stevecbc Same as above, Monocle icons are seen in the image. This is not OOTB and can confuse some users.

Choose a reason for hiding this comment

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

@stevecbc Same as above, Monocle icons are seen in the image. This is not OOTB and can confuse some users.

Choose a reason for hiding this comment

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

@stevecbc Same as above, Monocle icons are seen in the image. This is not OOTB and can confuse some users.

Choose a reason for hiding this comment

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

@stevecbc Same as above, Monocle icons are seen in the image. This is not OOTB and can confuse some users.

Choose a reason for hiding this comment

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

@stevecbc Group needs a title here

Copy link

@achintyabhat achintyabhat left a comment

Choose a reason for hiding this comment

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

@stevecbc This batch looks great. Just noticed that Monocle icons are seen in most of the images. This is not OOTB and can confuse some users. If you can update the images, this one is good to go.

Copy link

@achintyabhat achintyabhat left a comment

Choose a reason for hiding this comment

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

LGTM!

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