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

Add use case examples to make the documentation more friendly #477

Open
orhun opened this issue Feb 1, 2024 · 0 comments
Open

Add use case examples to make the documentation more friendly #477

orhun opened this issue Feb 1, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@orhun
Copy link
Owner

orhun commented Feb 1, 2024

Is your feature request related to a problem? Please describe.

A comment from Discord:

I found the doc examples lacking in terms of what options should be used for different workflows. Different users would want to generate changelogs at different points:

  • a new unreleased changelog update on each push to a development branch, and then a "release" when development is merged into main
  • a new unreleased update on each push to a main branch, and then a "release" when a tag is pushed

I found the docs confusing because I didn't know what combination of CLI options I should be using for my workflow.

Describe the solution you'd like

The examples are mostly just "use this flag to do this". Updates on this would help a lot for newbs to this like me

Describe alternatives you've considered

None.

Additional context

https://discord.com/channels/1093977388892819553/1094287935580418069/1202509640584265728

@orhun orhun added the documentation Improvements or additions to documentation label Feb 1, 2024
@orhun orhun self-assigned this Feb 1, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant