Skip to content

docs: write a release article in the blog #128

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

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

EscapedGibbon
Copy link
Contributor

No description provided.

@EscapedGibbon EscapedGibbon linked an issue Jul 18, 2025 that may be closed by this pull request
Copy link

cloudflare-workers-and-pages bot commented Jul 18, 2025

Deploying image-js-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 88543a4
Status: ✅  Deploy successful!
Preview URL: https://53d8ea22.image-js-docs.pages.dev
Branch Preview URL: https://127-write-a-release-article.image-js-docs.pages.dev

View logs

@EscapedGibbon
Copy link
Contributor Author

EscapedGibbon commented Jul 18, 2025

@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?

@EscapedGibbon EscapedGibbon marked this pull request as ready for review July 18, 2025 15:45
Copy link
Contributor

@stropitek stropitek left a comment

Choose a reason for hiding this comment

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

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)
CleanShot 2025-07-18 at 18 39 30@2x

@EscapedGibbon EscapedGibbon marked this pull request as draft July 22, 2025 07:17
@EscapedGibbon EscapedGibbon force-pushed the 127-write-a-release-article-in-the-blog branch from 2e7cb4b to f2a7939 Compare July 22, 2025 07:34
@EscapedGibbon EscapedGibbon marked this pull request as ready for review July 22, 2025 08:00
@EscapedGibbon EscapedGibbon requested a review from stropitek July 22, 2025 08:00
Copy link
Contributor

@stropitek stropitek left a comment

Choose a reason for hiding this comment

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

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

For example here I would have

  • Breaking changes
    • Loading images
    • Creating images
    • Masks
CleanShot 2025-07-22 at 10 37 32

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 EscapedGibbon marked this pull request as draft July 22, 2025 11:38
@EscapedGibbon EscapedGibbon marked this pull request as ready for review July 22, 2025 13:12
@EscapedGibbon EscapedGibbon marked this pull request as draft July 22, 2025 14:34
@EscapedGibbon EscapedGibbon marked this pull request as ready for review July 28, 2025 21:12
@EscapedGibbon EscapedGibbon force-pushed the 127-write-a-release-article-in-the-blog branch from 6ba3890 to 26cead8 Compare July 28, 2025 22:00
@EscapedGibbon EscapedGibbon marked this pull request as draft July 29, 2025 06:41
@EscapedGibbon EscapedGibbon force-pushed the 127-write-a-release-article-in-the-blog branch from 06ea397 to fd31809 Compare July 29, 2025 10:19
@EscapedGibbon EscapedGibbon marked this pull request as ready for review July 29, 2025 10:23
@EscapedGibbon
Copy link
Contributor Author

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.

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.

write a release article in the blog
2 participants