Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FIX] Update docs link in README.md #382

Merged
merged 1 commit into from
Nov 20, 2024
Merged

[FIX] Update docs link in README.md #382

merged 1 commit into from
Nov 20, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Nov 19, 2024

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass
  • If the PR changes the SPARQL query template, the default Neurobagel query file has also been regenerated

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

Summary by Sourcery

Bug Fixes:

  • Correct the links to the official documentation in the README.md file to point to the updated paths.

@alyssadai alyssadai added the skip-release PR doesn't appear in the changelog and preserves current version when merged label Nov 19, 2024
Copy link

sourcery-ai bot commented Nov 19, 2024

Reviewer's Guide by Sourcery

This PR updates documentation links in the README.md file to reflect the new URL structure that includes a 'user_guide' path segment. The changes are straightforward text replacements in the markdown file, updating several documentation links to point to their new locations.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Update documentation URLs to include 'user_guide' path segment
  • Update main API documentation link
  • Update getting started documentation link
  • Update configuration documentation link
  • Update Docker setup documentation link
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @alyssadai - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please fill out the 'Changes proposed' section in the PR description to document what was changed and why (in this case, updating documentation links to reflect the new URL structure).
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 11920964244

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.052%

Totals Coverage Status
Change from base Build 11789923180: 0.0%
Covered Lines: 823
Relevant Lines: 848

💛 - Coveralls

Copy link
Contributor

@surchs surchs left a comment

Choose a reason for hiding this comment

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

🧑‍🍳

@alyssadai alyssadai merged commit d9ba2c7 into main Nov 20, 2024
10 checks passed
@alyssadai alyssadai deleted the alyssadai-patch-1 branch November 20, 2024 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-release PR doesn't appear in the changelog and preserves current version when merged
Projects
Status: Review - Done
Development

Successfully merging this pull request may close these issues.

3 participants