Skip to content

docs: fix dead links in README and OpenMM integration page - #615

Merged
cw-tan merged 3 commits into
mir-group:developfrom
pratikgx:docs-fix-dead-links
Sep 28, 2026
Merged

cw-tan merged 3 commits into
mir-group:developfrom
pratikgx:docs-fix-dead-links

Conversation

@pratikgx

Copy link
Copy Markdown
Contributor

Description

  • README: the v0.7.0 upgrade notice links ./docs/guide/upgrading.md, which was removed in 2c602cd (May 2025), so the link 404s. It now points at the v0.7.0 release, which carries the upgrade notes.
  • docs/integrations/openmm.md: openmm.org/documentation is gone; the OpenMM user guide lives at docs.openmm.org/latest/userguide/.
  • CHANGELOG: entry under Unreleased / Fixed.

Motivation and Context

Both links are on the two pages a new user hits first (README, integration guide) and both return 404.

How Has This Been Tested?

Both replacement URLs return 200; the removal of upgrading.md confirmed in git history.

Types of changes

  • Documentation improvement (updates to user guides, docstrings, or developer docs)

Checklist:

  • I have read "Contributing to NequIP".
  • I have updated CHANGELOG.md.
  • I have updated the documentation (if relevant).
  • Code style / tests: not applicable, docs only.

- README: the v0.7.0 upgrade notice linked docs/guide/upgrading.md,
  which was removed in 2c602cd; point at the v0.7.0 release notes
- docs/integrations/openmm.md: openmm.org/documentation is gone; the
  user guide lives at docs.openmm.org
@cw-tan
cw-tan changed the base branch from main to develop September 26, 2026 19:48
@cw-tan

cw-tan commented Sep 27, 2026

Copy link
Copy Markdown
Collaborator

@pratikgx Thanks for the contribution. I'll merge it after I fix some unittests, which are unrelated to this PR.

@cw-tan
cw-tan merged commit 2fdf7fa into mir-group:develop Sep 28, 2026
3 checks passed
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.

2 participants