docs: write a release article in the blog

[EscapedGibbon]

No description provided.

[cloudflare-workers-and-pages]

Deploying image-js-docs with    Cloudflare Pages

Latest commit:	871bb4c
Status:	✅  Deploy successful!
Preview URL:	https://1303e0b1.image-js-docs.pages.dev
Branch Preview URL:	https://127-write-a-release-article.image-js-docs.pages.dev

View logs

[EscapedGibbon]

@stropitek

I think it can be reviewed in terms of structure and content, not sure if this is how it should be done. There are some things that should be mentioned:

1. The articles in blog section don't have the table of content on the right, like articles in the blog do. I suppose it has something to do with docusaurus.config. Should we add it?
2. I am not sure about the scope of the article. I believe it's not exactly a git hub list of commits with breaking changes, it's more user oriented. I am not sure if i went too much into details or the opposite.
3. I think we decided not to mention the "feature-matching" part of the API. Just making sure here, because it feels like, even though it's not an essential part of ImageJS, it might need a tutorial of sorts in this case.
4. Also, there were some minor additions like "clamped" versions of setPixel for example. Should I add those as new features?

[stropitek]

Maybe have another look before I dig deeper into reviewing this.

The content looks ok but there are numerous small issues

• Typos
• Table of content seem to be incomplete
• Some content could have better formatting (see screeshot)

[stropitek]

Can you review all titles and subtitles and make them simpler?

For example here I would have

• Breaking changes
  • Loading images
  • Creating images
  • Masks

---

Enhanced typescript support => not in the breaking changes category.

---

Whenever you say "xyz() function" you can replace with "xyz(), the "function" is redundant and even confusing since they are mostly class methods.

---

Removed features and be a sub-section of breaking changes.
Supported Node.js version can also be in the breaking changes.
The fact that we use typescript is not a breaking change, just an internal change. The package is published after having been transpiled to js, so it does not require typescript.

---

Please run a spell checker on your content, I spotted a few mistakes.

[EscapedGibbon]

After discussion it was decided to change default image in the demos.
Also check if there is a possibility to keep only functions and classes in the table of content of API documentation.

I will take a look another time if there were any important changes between versions that I forgot to mention.

[EscapedGibbon]

I think that concludes the documentation of important changes. The default image has been changed. The issue with tsdoc and its table of content belong to another issue, I think.

[stropitek]

Can you check all the code snippets / examples. There are unused imports, for example:

//Before
import { Image } from 'image-js';

const roiManager = mask.getRoiManager();
roiManager.fromMask(mask);
const rois = roiManager.getRois();

Here there is a unused Image import. I saw that other examples have that too.

---

I don't think it is common to have every word in titles start with an uppercase like in Stack Analysis Operations. Can you remove all those occurences?

[EscapedGibbon]

Can you check all the code snippets / examples. There are unused imports, for example:

//Before
import { Image } from 'image-js';

const roiManager = mask.getRoiManager();
roiManager.fromMask(mask);
const rois = roiManager.getRois();

Here there is a unused Image import. I saw that other examples have that too.

I don't think it is common to have every word in titles start with an uppercase like in Stack Analysis Operations. Can you remove all those occurences?

In this example Image import is actually used, because in the legacy version mask will be an instance of Image class. I will change the variable name to "img" so that it will be more clear what the variable represents. In the next example, however, Image import is not used, since mask will be an instance of Mask class. But if the mask is obtained through img.threshold() then mask is also unnecessary as import, so i will remove them altogether. Even without imports the example still gets the point across.