Outdated Burn Book Documentation in Production about burn

[nathanielsimard]

This is done on docs.rs, but not yet on the burn website, we could (should) implement the same feature for both the book and the hosted documentation. Will look into it for the new website.

[nathanielsimard]

This issue is a bit more complicated. We normally release the book with each new version of Burn, but sometimes there are updates that we need to perform after the release only for the book (like the vision feature). Other updates are current refactoring not included in the previous release.

However, most examples are on GitHub and not released. Therefore, people may discover Burn and play with it using the main unreleased version, while other people will read it and test on their own with the right version.

Maybe the best solution would be to guide people into trying the examples using the tagged version on GitHub (to avoid MnistBatch renames and other updates) and release patches if we find bugs in the book.

[antimora]

Is there a reason we do no publish 2 versions? Previous release and nightly? Heck, I would even recommend we publish all versions like PyTorch does and let the users use a dropdown to switch:

And we can just add a section like this to the book:

@syl20bnr, @Luni-4, @louisfd, any thoughts on this?

[syl20bnr]

Is there a reason we do no publish 2 versions? Previous release and nightly?

That's a great idea. We will make an official nightly version as well at some point so everything should fall into place.