Versioning

[jonedmiston]

First, thanks for this spec. It's proving very helpful for a large project I'm participating on.

One thing I thought I'd share, though it might be out of your scope of interest, was the concept of versioning. We're working to create some documentation for a fast moving framework that will have several releases each year. One thing we see as an issue is that users won't want to have to guess what has changed in the manuals from one version to the next. We hope that by adding a version label to specific elements we will be able to highlight what has changed from version to version (at least on the HTML version via some JavaScript).

Again, this might not be of any interest to you (just close this if it's not), but I thought I would share. You can see more of what we're thinking in our documentation on writing documentation.
https://github.com/SparkDevNetwork/Rock-ChMS/wiki/Formatting-Documentation#versioning

Thanks again for all your efforts!

[sandersk]

Hi @edmistj,

Thanks for getting in touch. It's great to see HTMLBook getting used out in the wild :)

I took a look at your documentation, and I really liked your approach of using the data-update-tag attribute for tagging content that has been modified in a specific version of the book.

The first release of the HTMLBook spec did not tackle versioning at all, but it's definitely something I'd like to explore for a future version (:wink:) of the spec. So we may indeed fold in the data-update-tag attribute or something similar. Will keep you posted!

Best,
Sanders