openzim
Add changelog to docs
Noticed the docs doesn't include the changelog which would be very handy and is common in similar projects (instead of root).
I don't understand this feature request. Why the changelog should be in docs?
For the same reason we include it in the sources. It's valuable piece of information that is tied with a specific release. Ideally, library users never have to come to the repository/github. Just using the online doc should be enough. Changelog contains information that's not reflected in the docs: added/dropped support for platforms, release-tied changes that would require a lot of browsing from the docs's version switcher to obtain, etc.
I opened the ticket when responding to https://github.com/openzim/wikihow/issues/166. I wanted to know when we introduced Windows support but it was not avail in the docs.
It's quite common for docs to provide this information. I'm actually surprised it raised a question.
A link would be enough indeed ; or a doc page containing it (docs are generated anyway)
@rgaudin All good, just not in favour of a duplicate (obviously) and pretty concerned by migrating the changelog outside the root.
not in favour of a duplicate (obviously)
Obviously
pretty concerned by migrating the changelog outside the root.
I guess #228 lead you to think this way. That's not wanted at all (nor required).