Skip to content

Fix broken links in docs - #1473

Open
AdrianDAlessandro wants to merge 6 commits into
mainfrom
fix-broken-links
Open

Fix broken links in docs#1473
AdrianDAlessandro wants to merge 6 commits into
mainfrom
fix-broken-links

Conversation

@AdrianDAlessandro

@AdrianDAlessandro AdrianDAlessandro commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Description

There are some broken links in the docs. Some are causing PR failures, but they don't necessarily line up with the broken links in the deployed docs. This PR will address these broken links.

Opening in draft because the CI workflow needs to be updated so the link checker is actually checking against the equivalent of the deployed docs. Edit: Ignoring broken links in old versions of the docs. These would be very difficult to continue to keep up to date. One problem is that this means the most recent release will include some broken links.

Fixes #1408

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 Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.78%. Comparing base (bdc4a1a) to head (f01eaaf).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1473   +/-   ##
=======================================
  Coverage   89.78%   89.78%           
=======================================
  Files          60       60           
  Lines        8439     8439           
  Branches     8439     8439           
=======================================
  Hits         7577     7577           
  Misses        545      545           
  Partials      317      317           

☔ View full report in Codecov by Harness.
📢 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.

@AdrianDAlessandro
AdrianDAlessandro marked this pull request as ready for review August 10, 2026 16:08
Copilot AI lite review requested due to automatic review settings August 10, 2026 16:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates documentation URL generation and link-checking to address broken links in the generated docs (including rustdoc pages) and to make CI’s link checker operate against the built documentation output.

Changes:

  • Update docs_url! to support an explicit documentation “version segment” (e.g. dev) when composing documentation URLs.
  • Fix an in-code rustdoc link to point at the dev docs location.
  • Update the docs link-checking workflow to resolve absolute paths against the built book/ output.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
src/simulation/prices.rs Adjust rustdoc link to use the dev docs URL segment.
src/lib.rs Extend docs_url! macro to accept an explicit version segment for URL construction.
docs/api/muse2/README.md Update the published API-docs URL to the dev docs location.
.github/workflows/check-docs.yml Configure Lychee to resolve absolute links relative to the built book/ output.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/simulation/prices.rs
//! Code for calculating commodity prices used by the simulation.
//!
#![doc = concat!("See <", crate::docs_url!("/model/prices.html"), ">")]
#![doc = concat!("See <", crate::docs_url!("dev", "model/prices.html"), ">")]
Comment thread src/lib.rs
)
docs_url!(concat!("v", env!("CARGO_PKG_VERSION")), $suffix)
};
($version:expr, $suffix:literal) => {
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken links after #1366

2 participants