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(changelog): move log to documentation #199

Merged
merged 8 commits into from
Aug 30, 2024
Merged

docs(changelog): move log to documentation #199

merged 8 commits into from
Aug 30, 2024

Conversation

nicrie
Copy link
Contributor

@nicrie nicrie commented Aug 30, 2024

This PR make the following modifications to the CHANGELOG:

  • Include CHANGELOG as a new page into the online documentation
  • Run cliff after release to ensure that new changes are include into CHANGELOG
  • add myst-parser as additional dependency
  • change icons from shortcodes to unicode so that they show up correctly

myst-parser allows to include markdown files into the shinx documentation which requires rst files.
Run git-cliff after the release to ensure that the latest changes are incroporated; update Github Action to new v3 according to the official Github Action readme (https://github.com/orhun/git-cliff-action?tab=readme-ov-file#committing-the-changelog)
Not needed anymore since we're using git-cliff.
@nicrie nicrie merged commit c9de931 into main Aug 30, 2024
6 checks passed
@slevang
Copy link
Contributor

slevang commented Aug 31, 2024

Nice, I noticed the changelog was showing the latest changes as unreleased.

@nicrie nicrie deleted the whats-new-docs branch September 13, 2024 13:27
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.

2 participants