Documentation Update

[bennibbelink]

The biggest changes are master to main. I also updated the Ubuntu versions and changed the links to point to our GitHub releases.

The minimum required Cyclus version will need to be updated again when we issue the new release.

I will make a separate PR for documenting our container images as an installation option.

[github-actions]

Build Status Report - 95adfa1 - 2024-03-25 22:48:08 +0000

Build FROM cyclus_20.04_apt/cyclus:latest

• Cycamore: Success ✅
• Cymetric: Success ✅

Build FROM cyclus_20.04_apt/cyclus:stable

• Cycamore: Failure ❌
• Cymetric: Skipped due to upstream failure ⚠️

Build FROM cyclus_20.04_conda/cyclus:latest

• Cycamore: Success ✅
• Cymetric: Success ✅

Build FROM cyclus_20.04_conda/cyclus:stable

• Cycamore: Failure ❌
• Cymetric: Skipped due to upstream failure ⚠️

Build FROM cyclus_22.04_apt/cyclus:latest

• Cycamore: Success ✅
• Cymetric: Success ✅

Build FROM cyclus_22.04_apt/cyclus:stable

• Cycamore: Failure ❌
• Cymetric: Skipped due to upstream failure ⚠️

Build FROM cyclus_22.04_conda/cyclus:latest

• Cycamore: Success ✅
• Cymetric: Success ✅

Build FROM cyclus_22.04_conda/cyclus:stable

• Cycamore: Failure ❌
• Cymetric: Skipped due to upstream failure ⚠️

[gonuke]

Thanks @bennibbelink - this looks good. Do we merge ASAP, or do we need to do the release first/simultaneously? I ask because the (working/up-to-date) DEB packages don't actually exist yet, do they?

[bennibbelink]

Good point, we should probably wait until the release.

[gonuke]

It does create a bit of a race condition... since it would be good to update docs as much as possible before release :)

[bennibbelink]

I wonder if maybe in the cyclus.github.com #349 we should use the cymetric:stable version (after release of course so the image actually exists). That way we could have a working version of the docs on main prior to a release, but they won't actually be published to the site until the next release.

Up to you whether we merge this PR now or wait. The DEB package links are broken now anyway - changing the broken links for different broken links doesn't sound like the end of the world

[gonuke]

Thanks @bennibbelink - let's do this now and revisit what we need to at release time