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

DYN-5322 Update ML NodeAutocomplete Documentation #13602

Merged
merged 2 commits into from
Dec 7, 2022
Merged

DYN-5322 Update ML NodeAutocomplete Documentation #13602

merged 2 commits into from
Dec 7, 2022

Conversation

RobertGlobant20
Copy link
Contributor

Purpose

Update ML NodeAutocomplete Documentation
I updated the NodeAutocompleteDcoumentation.html to match the docx document attached to the Jira task. For the GIFs/PNG updated I did the next actions:

  • Modified the original images resolution to 450 x XXX (according to the aspect ratio).
  • Compressed the modified image/GIF so it will use the minimum size in the html file when converted to Base 64 (otherwise the WebView2 component was crashing).
  • Convert the Image/GIF to Base64 content and put it in the HTML file.

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

Update ML NodeAutocomplete Documentation

Reviewers

@QilongTang

FYIs

I updated the NodeAutocompleteDcoumentation.html to match the docx document attached to the Jira task.
For the GIFs/PNG updated I did the next actions:
- Modified the original images resolution to 450 x XXX (according to the aspect ratio).
- Compressed the modified image/GIF so it will use the minimum size in the html file when converted to Base 64 (otherwise the WebView2 component was crashing).
- Convert the Image/GIF to Base64 content and put it in the HTML file.
@RobertGlobant20
Copy link
Contributor Author

This is a GIF showing the Documentation updated.
DocMLNodeAutocomplete (1)

@QilongTang
Copy link
Contributor

This looks good, @RobertGlobant20 can you hook this up to the preferences panel? There was a question mark with hover over tooltip of Learn More about NodeAutoComplete, but clicking on it does not show this doc

I've added the MouseDown event and the handler so every time the question mark symbol is clicked in the preferences panel the DocumentationBrowser ML NodeAutocomplete documentation will be opened.
@RobertGlobant20
Copy link
Contributor Author

GIF showing that after clicking the question mark symbol in the Preferences panel the documentation will be opened.
Preferen esDocMLNodeAutocomplete

@RobertGlobant20
Copy link
Contributor Author

This looks good, @RobertGlobant20 can you hook this up to the preferences panel? There was a question mark with hover over tooltip of Learn More about NodeAutoComplete, but clicking on it does not show this doc

@QilongTang fixed in the next commit: bb1eb9a

@QilongTang QilongTang merged commit 483d9ee into DynamoDS:master Dec 7, 2022
@QilongTang QilongTang deleted the DYN-5322-Doc-MLNodeAutocomplete branch December 7, 2022 03:51
QilongTang pushed a commit that referenced this pull request Dec 7, 2022
* DYN-5322-Doc-MLNodeAutocomplete

I updated the NodeAutocompleteDcoumentation.html to match the docx document attached to the Jira task.
For the GIFs/PNG updated I did the next actions:
- Modified the original images resolution to 450 x XXX (according to the aspect ratio).
- Compressed the modified image/GIF so it will use the minimum size in the html file when converted to Base 64 (otherwise the WebView2 component was crashing).
- Convert the Image/GIF to Base64 content and put it in the HTML file.

* DYN-5322-Doc-MLNodeAutocomplete CodeReview1

I've added the MouseDown event and the handler so every time the question mark symbol is clicked in the preferences panel the DocumentationBrowser ML NodeAutocomplete documentation will be opened.
@QilongTang QilongTang mentioned this pull request Dec 7, 2022
8 tasks
QilongTang added a commit that referenced this pull request Dec 7, 2022
* Include all files from Markdown Directory to published package (#13607)

* update

* add all files under Markdown Dir to pkg

* update comment

* update tests

* update test

* update tests

* update comments

* update test

* Adding localization for the sign in button states (#13612)

* DYN-5322 Update ML NodeAutocomplete Documentation (#13602)

* DYN-5322-Doc-MLNodeAutocomplete

I updated the NodeAutocompleteDcoumentation.html to match the docx document attached to the Jira task.
For the GIFs/PNG updated I did the next actions:
- Modified the original images resolution to 450 x XXX (according to the aspect ratio).
- Compressed the modified image/GIF so it will use the minimum size in the html file when converted to Base 64 (otherwise the WebView2 component was crashing).
- Convert the Image/GIF to Base64 content and put it in the HTML file.

* DYN-5322-Doc-MLNodeAutocomplete CodeReview1

I've added the MouseDown event and the handler so every time the question mark symbol is clicked in the preferences panel the DocumentationBrowser ML NodeAutocomplete documentation will be opened.

Co-authored-by: filipeotero <[email protected]>
Co-authored-by: Roberto T <[email protected]>
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.

3 participants