point current dev version at index.html

[Aurashk]

Description

This works for me locally, although not sure how to test in production without merging, couple of thoughts I had along the way:

• In our current docs v2.1.0 is missing, do we need to set up the python scripts (generate_versions_docs.py and friends) to run in our release CI or something?
• Now that we are making releases, do we want Making a release section to our developer guide? Like a list of steps to follow when making a release.

Fixes #1254

Type of change

• Bug fix (non-breaking change to fix an issue)
• New feature (non-breaking change to add functionality)
• Refactoring (non-breaking, non-functional change to improve maintainability)
• Optimization (non-breaking change to speed up the code)
• Breaking change (whatever its nature)
• Documentation (improve or add documentation)

Key checklist

• All tests pass: $ cargo test
• The documentation builds and looks OK: $ cargo doc
• Update release notes for the latest release if this PR adds a new feature or fixes a bug
  present in the previous release

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.74%. Comparing base (a10a1f4) to head (e096e8e).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1262   +/-   ##
=======================================
  Coverage   89.74%   89.74%           
=======================================
  Files          57       57           
  Lines        8195     8195           
  Branches     8195     8195           
=======================================
  Hits         7355     7355           
  Misses        544      544           
  Partials      296      296           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

Fixes the “Current development version” link on the documentation versions page so it routes to the built docs homepage instead of a missing Markdown source file (Issue #1254).

Changes:

• Update the “Current development version” link target from ./README.md to index.html in the versions page template.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[alexdewar]

LGTM!

This works for me locally, although not sure how to test in production without merging, couple of thoughts I had along the way:

It works for me locally too. I assume it'll work in production, but there are some weird discrepancies as you point out...

• In our current docs v2.1.0 is missing, do we need to set up the python scripts (generate_versions_docs.py and friends) to run in our release CI or something?

When I run it locally I see v2.1.0, but you're right that it doesn't appear on our website 😞. I'm not sure what's happening. The CI is just running just build-docs::all_with_old, so it should work the same as it does locally. It gets the version numbers from git tags, but the same tags should be available to GitHub's runners, so this is really odd.

Let's see what happens when we merge and then I'll open a separate issue about this.

• Now that we are making releases, do we want Making a release section to our developer guide? Like a list of steps to follow when making a release.

Good idea! I've opened an issue for this: #1164

[alexdewar]

PS -- I also noticed that when I run it locally, the 404 page you see for broken links is formatted correctly, in contrast to what you see on the actual website (as @tsmbland reported). Weird.

[alexdewar]

Now that we've merged #1266, it seems that the docs for v2.1.0 are appearing: https://energysystemsmodellinglab.github.io/MUSE2/versions.html