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: Add changelog to docs #1574

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Conversation

vigneshmanick
Copy link
Contributor

Summary

Add a hook to copy the changelog to the docs build so that it's available via the site too. I was frequently swapping between github and the website to see the changes in the new versions.

Also updated is the exitsting changelog itself so that the TOC is rendered properly in the built site. See preview below

image

In addition, the template used to generate the documentation has also been modified slightly so that the future docs are rendered with the updated heading sections.

@vigneshmanick
Copy link
Contributor Author

please review

@vigneshmanick vigneshmanick marked this pull request as ready for review July 7, 2024 17:48
Copy link
Contributor

@ruben-arts ruben-arts left a comment

Choose a reason for hiding this comment

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

Great idea! one small remark will merge it immediately with it!

mkdocs.yml Outdated Show resolved Hide resolved
@ruben-arts ruben-arts merged commit acd2c36 into prefix-dev:main Jul 8, 2024
19 checks passed
@vigneshmanick vigneshmanick deleted the changelog-docs branch July 8, 2024 18:02
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