docs: update documentation on transform function

[EscapedGibbon]

No description provided.

[cloudflare-workers-and-pages]

Deploying image-js-docs with    Cloudflare Pages

Latest commit:	2712e93
Status:	✅  Deploy successful!
Preview URL:	https://81a0eeeb.image-js-docs.pages.dev
Branch Preview URL:	https://123-update-documentation-on.image-js-docs.pages.dev

View logs

[EscapedGibbon]

I have some doubts about some parts of the tutorial that i want to mention @stropitek :

1. I find the current tutorial practical but it doesn't really explain what image transformation really is in too much detail. Is there a need perhaps to add some explanation of how matrix multiplication in image transformation work?
2. We haven't really discussed it, but the transform() demo in the features folder remains unchanged. I think the image-js release is needed and perhaps i should add the "getPerspectiveWarp" function afterwards so it can be accessed in the demo?
3. The image at the beginning of the tutorial shows well how different matrices change coordinates, but it uses a 3x2 matrix, when our function accepts 2x3. Is this too misleading? Should I remove the image or maybe put a note explaining the difference?
4. I propose to add another page in Useful Tips dedicated to parameters in "transform()" function in a separate commit. I think it is worth explaining more different interpolation types and border handling. It can also explain "fullImage" and "inverse" parameters because I don't think that explanation on "transform()" feature page is enough.
5. I made a small change in package-json and added exports field so that test-package workflow passes. I am not sure if I did it correctly.

[stropitek]

Good work on the tutorial!

1. I find the current tutorial practical but it doesn't really explain what image transformation really is in too much detail. Is there a need perhaps to add some explanation of how matrix multiplication in image transformation work?

You can add a reference if you have a good one, but let's not go into too many mathematical details in those tutorials. They should remain simple.

In the example which multiplies matrices, you can also show how to do the calculation with ml-matrix, and add a link to the library.

2. We haven't really discussed it, but the transform() demo in the features folder remains unchanged. I think the image-js release is needed and perhaps i should add the "getPerspectiveWarp" function afterwards so it can be accessed in the demo?

Yes you can add a new page to "features/geometry". I think an explanation / API description should be enough, it's not easy to do a useful demo for getPerspectiveWarp.

3. The image at the beginning of the tutorial shows well how different matrices change coordinates, but it uses a 3x2 matrix, when our function accepts 2x3. Is this too misleading? Should I remove the image or maybe put a note explaining the difference?

Do you mean the gif at the beginning? If you have done it yourself you can correct it if it's not too much work. If you found it, it is fine you can leave it like that without further explanations.

4. I propose to add another page in Useful Tips dedicated to parameters in "transform()" function in a separate commit. I think it is worth explaining more different interpolation types and border handling. It can also explain "fullImage" and "inverse" parameters because I don't think that explanation on "transform()" feature page is enough.

Yes why not, you can create an issue about this. Would be nice to have a (not necessarily exhaustive) list of methods which have those options. Would be an opportunity to check that they all share the same API as well.

5. I made a small change in package-json and added exports field so that test-package workflow passes. I am not sure if I did it correctly.

This is not a published library so you can revert that change and disable the test-package workflow. Here is workflow's input to configure that: https://github.com/zakodium/workflows/blob/e95b919cfd1754f0e2ca4b98f13445a330a1f71a/.github/workflows/nodejs.yml#L38

[EscapedGibbon]

• I have added the explanation for matrix multiplication in image transformations, but i feel like the part about "ml-matrix" is out of place here. Maybe i misunderstood what you meant.

[stropitek]

@EscapedGibbon as it is really difficult to have a working state for the build when updating any dependency, I reverted to the package-lock of the main branch.

We don't need to update image-js since the new features are only documented, not used in the demos.

Let's handle deps update in a future PR.

[EscapedGibbon]

@EscapedGibbon as it is really difficult to have a working state for the build when updating any dependency, I reverted to the package-lock of the main branch.

We don't need to update image-js since the new features are only documented, not used in the demos.

Let's handle deps update in a future PR.

Then I only modify the part about ml-matrix as was discussed. I made it as a dropdown link, to not to overcrowd the documentation.

[stropitek]

I thought from our discussions that you would update this example to show how the matrix could also be computed using mljs by multipling a translation and a rotation together.

Otherwise LGTM.

[EscapedGibbon]

I thought from our discussions that you would update this example to show how the matrix could also be computed using mljs by multipling a translation and a rotation together.

Otherwise LGTM.

Yeah, you're right, I think it can be combined into one section.