Skip to content
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

Merged
merged 6 commits into from
May 27, 2024
Merged

docs: new changelogs #1707

merged 6 commits into from
May 27, 2024

Conversation

aakrem
Copy link
Collaborator

@aakrem aakrem commented May 26, 2024

Added new changelogs

Copy link

vercel bot commented May 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
agenta ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 27, 2024 7:19pm

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels May 26, 2024
Copy link
Member

@mmabrouk mmabrouk left a 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.

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels May 26, 2024
@aakrem
Copy link
Collaborator Author

aakrem commented May 26, 2024

fixed

Copy link
Member

@mmabrouk mmabrouk left a 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.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 27, 2024
@mmabrouk mmabrouk merged commit 21c5e50 into main May 27, 2024
3 of 4 checks passed
@mmabrouk mmabrouk deleted the changelog branch May 27, 2024 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants