-
Notifications
You must be signed in to change notification settings - Fork 224
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: new changelogs #1707
docs: new changelogs #1707
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
This changelog is neither in the right format nor is informative.
The goal of the changelog in this case is not to mirror github, but to provide the user/prospect of a high level overview of what has changed in the platform. Things like "Enhanced Docker assets", "Added openapi to mint.json", "Fixed references and updated openapi.json" are meaningless for anyone other than the developer team.
The changelog should describe the main features added to the platform, preferably with screenshots to explain the improvement addition. It can also provide a number of small bug fixes / other improvements in a list format in a humanly understandable way.
I will rewrite the changelog in this PR to provide an example for the future.
fixed |
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.
I made some changes here.
Feedback: Try to create a story (for instance by putting playground improvements all together). Don't forget big issues (agenta as a prompt mangement). Add bug fixes here and there if they are clear. Explain the context of things.
Added new changelogs