Skip to content
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

Add NodeHelpDocs in Dynamo Repo #12684

Merged
merged 1 commit into from
Mar 10, 2022
Merged

Add NodeHelpDocs in Dynamo Repo #12684

merged 1 commit into from
Mar 10, 2022

Conversation

QilongTang
Copy link
Contributor

@QilongTang QilongTang commented Mar 10, 2022

Please Note:

  1. Before submitting the PR, please review How to Contribute to Dynamo
  2. Dynamo Team will meet 1x a month to review PRs found on Github (Issues will be handled separately)
  3. PRs will be reviewed from oldest to newest
  4. If a reviewed PR requires changes by the owner, the owner of the PR has 30 days to respond. If the PR has seen no activity by the next session, it will be either closed by the team or depending on its utility will be taken over by someone on the team
  5. PRs should use either Dynamo's default PR template or one of these other template options in order to be considered for review.
  6. PRs that do not have one of the Dynamo PR templates completely filled out with all declarations satisfied will not be reviewed by the Dynamo team.
  7. PRs made to the DynamoRevit repo 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 a LGTM label is added to the PR.

Purpose

This is the initial PR

 .\NodeDocumentationMarkdownGenerator.exe fromdirectory -i "C:\Users\xxx\Documents\GitHub\Dynamo\bin\AnyCPU\Debug" -o "./docs" -w -s -d "C:\Users\xxx\Documents\GitHub\DynamoDictionary\public\data\Dynamo_Nodes_Documentation.json" -x "C:\Users\xxx\Documents\GitHub\Dynamo\src\LibraryViewExtension\web\library\layoutSpecs.json" -f UnitsUI.dll

Binaries covered can be found at Jira task https://jira.autodesk.com/browse/DYN-4001

We can create further CI job to update these documents when needed at release stage or by dev request.

Declarations

Check these if you believe they are true

  • The codebase 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
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated

Release Notes

Add NodeHelpDocs in Dynamo Repo

Reviewers

@DynamoDS/dynamo

FYIs

(FILL ME IN, Optional) Names of anyone else you wish to be notified of

@dynamo-ci-user
Copy link

dynamo-ci-user commented Mar 10, 2022 via email

@QilongTang
Copy link
Contributor Author

@reddyashish Yes I did, let me update the description and give an example command

@mjkkirschner
Copy link
Member

mjkkirschner commented Mar 10, 2022

@QilongTang reviewing this literally freezes my browser 🙃 - can you add to this PR description which binaries this PR covers?

@QilongTang QilongTang merged commit d5f98ce into master Mar 10, 2022
@QilongTang QilongTang deleted the AddNodeHelpDocs branch March 10, 2022 22:34
@QilongTang QilongTang added this to the 2.14.0 milestone Mar 10, 2022
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.

5 participants