[GH-ISSUE #254] Separate changelog and documentation in Readme. #711

New issue

Open

opened 2026-03-01 17:41:06 +03:00 by kerem · 1 comment

kerem commented

2026-03-01 17:41:06 +03:00

Owner

Originally created by @SeppPenner on GitHub (Apr 7, 2019).
Original GitHub issue: https://github.com/aluxnimm/outlookcaldavsynchronizer/issues/254

I would recommend to separate the changelog from the user documentation in the readme. Why? Because nobody wants to scroll down to the documentation while reading all the changes made from version 0.x to version 3.x. I would recommend to make a new file called changelog.md in the main folder or something and link it from the README.md file.

Originally created by @SeppPenner on GitHub (Apr 7, 2019). Original GitHub issue: https://github.com/aluxnimm/outlookcaldavsynchronizer/issues/254 I would recommend to separate the changelog from the user documentation in the readme. Why? Because nobody wants to scroll down to the documentation while reading all the changes made from version 0.x to version 3.x. I would recommend to make a new file called `changelog.md` in the main folder or something and link it from the `README.md` file.

kerem commented

2026-03-01 17:41:07 +03:00

Author

Owner

@aluxnimm commented on GitHub (Apr 7, 2019):

Yes good point. Just need to change the update logic then as well since changes are grepped from readme atm.

You can read documentation also at

https://caldavsynchronizer.org/help/documentation/

@aluxnimm commented on GitHub (Apr 7, 2019): Yes good point. Just need to change the update logic then as well since changes are grepped from readme atm. You can read documentation also at https://caldavsynchronizer.org/help/documentation/