Changelog in master since 0.9.9

[philfreo]

I know historically documentation changes and changelog additions weren't made until a release was cut, but can I suggest that a better process would be to update the docs and add to a changelog as API-changing pull requests get accepted in master? It would probably result in much less of a scramble to fix mistakes in the docs after a release is made (as was the case in 0.9.9).

For example, I'd like to know what intentional changes have been made since 0.9.9 because I've got several bugs in my application when using master, that don't exist when on 0.9.9. Additionally, it was very simple to upgrade Backbone-Relational from 0.9.2 to 0.9.9 but the project (and its tests) is broken on the current master.

I believe these problems are related to when the "simple" branch was merged in, but I'm unclear exactly what API changes were made intentionally vs. unintentionally, so it's hard to contribute a meaningful patch or test case.

[tgriesser]

I agree with this, keeping the index.html docs up to date with changes after a release wouldn't have any effect on the backbonejs.org, and would be easier than making all updates before a release (especially if there is a longer span between releases).

Keeping an "edge" section above the change log with a running set of changes (especially big ones like the validation reversal, or the simple changes and removal of model.change()) would be better for someone looking to grab a copy of the repo and quickly see a documentation which reflects the current state of the project.

/cc @jashkenas @braddunbar @caseywebdev

[caseywebdev]

👍 x 100 I already forget all the changes on master since 0.9.9 was cut. I love this idea. Master branch docs to go with the master branch updates.

[gsamokovarov]

Writing the changelog as we go is a great idea. 👍

[braddunbar]

Wonderful idea. A concrete list of edge changes would be great.

-brad

On Tue, Jan 8, 2013 at 3:41 AM, Genadi Samokovarov <notifications@github.com

wrote:

Writing the changelog as we go is a great idea. [image: 👍]

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/2086#issuecomment-11988799.

[akre54]

Is there any way the backbonejs.org site could be versioned? the docs and annotated source are remarkably helpful, but become much less so if you're not using the latest version

[caseywebdev]

@akre54 It is versioned!

https://raw.github.com/documentcloud/backbone/0.9.1/index.html
https://raw.github.com/documentcloud/backbone/0.9.2/index.html
https://raw.github.com/documentcloud/backbone/0.9.9/index.html
https://raw.github.com/documentcloud/backbone/master/index.html

[akre54]

Whoah. mind == blown. Thanks @caseywebdev

[caseywebdev]

Thank github for awesome URL practices 👍

[akre54]

PS tip (to future me and others): appending http://htmlpreview.github.com/? before the link will show docs as HTML: http://htmlpreview.github.com/?https://raw.github.com/documentcloud/backbone/0.9.2/index.html

[caseywebdev]

Ah yes I forgot about htmlpreview, good call!

[philfreo]

closing since #2092 was merged