Skip to content
This repository has been archived by the owner on Jan 7, 2025. It is now read-only.

Changelog added to docs and displayed #519

Merged
merged 2 commits into from
Feb 13, 2024
Merged

Changelog added to docs and displayed #519

merged 2 commits into from
Feb 13, 2024

Conversation

jakethekoenig
Copy link
Member

I added CHANGELOG.rst to our project root and made it a page on the docs. If the user is using an outdated version the most recent changelog is displayed as part of the prompt to upgrade.

Pull Request Checklist

  • Documentation has been updated, or this change doesn't require that

I added CHANGELOG.rst to our project root and made it a page on the
docs. If the user is using an outdated version the most recent changelog
is displayed as part of the prompt to upgrade.
CHANGELOG.rst Outdated
`1.0.9 <https://pypi.org/project/mentat/1.0.9/>`__
--------------------------------------------------

- Adds `/ammend` command: clear last message and prefill with last prompt.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo

Copy link
Member

@PCSwingle PCSwingle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this! Looks great, although I think it would be nice to print the changelog for all versions after the current version (rather than just the most recent version). Would this be too difficult?

@jakethekoenig
Copy link
Member Author

jakethekoenig commented Feb 12, 2024

Thanks for adding this! Looks great, although I think it would be nice to print the changelog for all versions after the current version (rather than just the most recent version). Would this be too difficult?

I could do that. I worry it'd be strange if the user hasn't used it for a few versions to print a huge wall of text though. And in general we release infrequently enough weekly users shouldn't miss changelogs printed with this feature.

To say more: This feature is inspired by discord's changelog and they never show me a huge changelog even when I occasionally go months without using the product.

@jakethekoenig jakethekoenig merged commit 7e0b00b into main Feb 13, 2024
16 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants