-
Notifications
You must be signed in to change notification settings - Fork 0
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
base: main
Are you sure you want to change the base?
Conversation
Deploying image-js-docs with
|
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 |
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:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2e7cb4b
to
f2a7939
Compare
There was a problem hiding this 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

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.
6ba3890
to
26cead8
Compare
06ea397
to
fd31809
Compare
After discussion it was decided to change default image in the demos. I will take a look another time if there were any important changes between versions that I forgot to mention. |
No description provided.