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

Docs: Resolves #10341: Document the drawing option #10436

Conversation

personalizedrefrigerator
Copy link
Collaborator

@personalizedrefrigerator personalizedrefrigerator commented May 16, 2024

Summary

This pull request adds documentation for the mobile drawing option. It resolves #10341.

Testing

This pull request has been rendered by:

  1. running yarn run buildWebsite
  2. cancelling after markdown files are processed and assets are copied, then,
  3. from packages/doc-builder, running yarn start.
Rendered preview

screenshot: Rendered version of drawing.md

@laurent22
Copy link
Owner

Thanks for creating the doc! I don't assume it's possible to write it in such a way that it would apply to both desktop and mobile?

Also is it possible to remove the explanation text from the images and, for example, put it below the image (as text)? This is because we translate the doc and images are harder to translate

@personalizedrefrigerator
Copy link
Collaborator Author

Also is it possible to remove the explanation text from the images and, for example, put it below the image (as text)? This is because we translate the doc and images are harder to translate

Yes, that should be possible. One way to implement this could be with a figcaption element.

This could either be done directly as HTML or, with MDX, as suggested by either this GitHub discussion or this blog post (both describe different approaches).

I don't assume it's possible to write it in such a way that it would apply to both desktop and mobile?

I think the only mobile-specific content is in the "adding a drawing" and "editing an existing drawing" sections. It should be possible to rewrite these to describe how to do things on both mobile and desktop.

@laurent22
Copy link
Owner

Yes, that should be possible. One way to implement this could be with a figcaption element.

This could either be done directly as HTML or, with MDX, as suggested by either this GitHub discussion or this blog post (both describe different approaches).

figcaption seems simpler? Usually I just simply put some text below the image, but figcaption seems more proper.

I think the only mobile-specific content is in the "adding a drawing" and "editing an existing drawing" sections. It should be possible to rewrite these to describe how to do things on both mobile and desktop.

That would be great, so that users can see at a glance how it works in general, and what are the differences between platforms

@personalizedrefrigerator personalizedrefrigerator added documentation Documentation, web site, README draw JS-Draw related issues labels May 24, 2024
@laurent22 laurent22 merged commit b0d0e64 into laurent22:dev May 28, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation, web site, README draw JS-Draw related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create doc for Drawing option
2 participants