Repository navigation
Fix documentation link in README - #421
Merged
Merged
Conversation
Updated the documentation link to point to the latest version.
🦙 MegaLinter status:
|
| Descriptor | Linter | Files | Fixed | Errors | Elapsed time |
|---|---|---|---|---|---|
| black | 35 | 1 | 0.75s | ||
| ✅ PYTHON | pylint | 35 | 0 | 5.43s |
See detailed report in MegaLinter reports
There was a problem hiding this comment.
🟢 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 Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ 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.
🚀 New features to boost your workflow:
|
jmafoster1
reviewed
Oct 23, 2026
jmafoster1
approved these changes
Oct 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
docs/and checked for updated configuration/runtime optionsdocs/source/tutorialsfor any new functionalitysphinx-build -W source/ build