cunarist / rinf

Rust for native business logic, Flutter for flexible and beautiful GUI
MIT License
1.89k stars 66 forks source link

Added last edit date to mkdocs documentation by the "git-revision-date-localized-plugin" #276

Closed VictorieeMan closed 8 months ago

VictorieeMan commented 8 months ago

Having used the documentation over a week, I accidentally followed it on different days during two different updates - leading to some confusing results. I think its a good idea to add a "last edited" date on every page.

I use this plugin on my own mkdocs sites and the timestamps looks like this: image

and it uses the git commit date to keep the timestamps updated => minimizing the manual work needed to keep this data up to date. It even works for all the posts already uploaded before this plugin is added.

Reference to the package: https://pypi.org/project/mkdocs-git-revision-date-localized-plugin/

NOTE: I assumed plugins could be added as in a locally run mkdocs file. Please take a look so that the changes in documentation/pyproject.toml are correctly implemented. My assumption is that it wanted the pyp pip install package name on a new line in the file.

I took myself the liberty of suggesting this change directly rather than first creating an issue. Considering, it's a side issue to the maintenance of the code base.

temeddix commented 8 months ago

Thank you very much! I will review it and merge it as soon as possible :)

temeddix commented 8 months ago

Your idea really helped in terms of documentation quality, as it is now possible to see the date modified and check the latest status. Thanks :)