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

Update/SOF-7289 Documentation on JupyterLite Dialog #270

Merged
merged 22 commits into from
Apr 8, 2024

Conversation

VsevolodX
Copy link
Contributor

No description provided.

Copy link

netlify bot commented Apr 5, 2024

Deploy Preview for mat3ra-documentation ready!

Name Link
🔨 Latest commit 350d8fc
🔍 Latest deploy log https://app.netlify.com/sites/mat3ra-documentation/deploys/6610bf744536560008b0768e
😎 Deploy Preview https://deploy-preview-270--mat3ra-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

## Animation

The following animation illustrates how to use the JupyterLite Transformation Dialog to create a matching interface between two surfaces using Zur and McGill's algorithm.

Copy link
Member

Choose a reason for hiding this comment

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

Let's make sure the images are:

  • added via LFS
  • in webp format
  • add explanation to README about webp

Copy link
Contributor

Choose a reason for hiding this comment

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

Last time, we did add brief info about webp in the INTERNAL.md

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Probably it's better to have it in the README under "including images" section.

Copy link
Member

Choose a reason for hiding this comment

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

Let's keep it in README, probably more visible


The JupyterLite Transformation Dialog enables the modification of materials within the JupyterLite environment, which is a lightweight implementation of JupyterLab that runs entirely in the browser. This dialog is accessible via the ["Advanced" menu](../advanced.md) within the Materials Designer interface.

![Materials Designer header with Advanced menu opened](../../../../../../images/materials-designer/jupyterlite_dialog/open-jupyterlite-dialog.webp "Open JupyterLite Transformation Dialog")
Copy link
Member

Choose a reason for hiding this comment

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

Let's add a link to the lang/en/docs folder and link images into it to avoid having to go all the way to the top level here

Copy link
Contributor

Choose a reason for hiding this comment

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

Alternatively, we may use absolute paths for images, in this case, it's /images/materials-designer/jupyterlite_dialog/open-jupyterlite-dialog.webp.

@VsevolodX VsevolodX merged commit 2a054ff into master Apr 8, 2024
8 checks passed
@VsevolodX VsevolodX deleted the update/SOF-7289 branch April 8, 2024 16:18
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.

None yet

3 participants