Skip to content

Fix documentation link in README - #421

Merged
neilwalkinshaw merged 2 commits into
mainfrom
neilwalkinshaw-patch-1
Oct 28, 2026
Merged

neilwalkinshaw merged 2 commits into
mainfrom
neilwalkinshaw-patch-1

Conversation

@neilwalkinshaw

Copy link
Copy Markdown
Collaborator

Updated the documentation link to point to the latest version.

Summary

What does this PR do?

Main file changes

Summarise changes to main files to be reviewed.

Checklist

Before you mark your PR as ready for review, please ensure you have completed the following.

  • Added unit tests for new functionality
  • Properly documented any new code
  • Updated Sphinx documentation in docs/ and checked for updated configuration/runtime options
  • Added a jupyter notebook tutorial in docs/source/tutorials for any new functionality
  • Verified local docs build with sphinx-build -W source/ build

Updated the documentation link to point to the latest version.
Copilot AI balanced review requested due to automatic review settings October 21, 2026 19:52
@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

🦙 MegaLinter status: ⚠️ WARNING

Descriptor Linter Files Fixed Errors Elapsed time
⚠️ PYTHON black 35 1 0.75s
✅ PYTHON pylint 35 0 5.43s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

The change is limited to a documentation link and has no identified issues.

No open issues 🎉

What changed in this PR

Updates the README’s Usage documentation link to the latest documentation landing page.

Changes:

  • Replaces the direct tutorials URL with the documentation homepage URL.
File Description
README.md Updates the documentation link in the Usage note.

Review effort: Balanced

@codecov

codecov Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.94%. Comparing base (7188c3d) to head (8b7d790).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #421   +/-   ##
=======================================
  Coverage   97.94%   97.94%           
=======================================
  Files          29       29           
  Lines        1898     1898           
=======================================
  Hits         1859     1859           
  Misses         39       39           

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8abdd0c...8b7d790. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread README.md Resolved

@jmafoster1 jmafoster1 left a comment •

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good spot, LGTM. I removed the ?badge=latest parameter from the URL as it didn't seem to do affect anything. Feel free to put it back.

@neilwalkinshaw
neilwalkinshaw merged commit 7ab4da9 into main Oct 28, 2026
28 of 29 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.

3 participants