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 outdated docs links #839

Merged
merged 3 commits into from
Dec 19, 2024
Merged

[FIX] Update outdated docs links #839

merged 3 commits into from
Dec 19, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Dec 19, 2024

Changes proposed in this PR:

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 links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

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

@alyssadai alyssadai added release Create a release when this PR is merged pr-bug-fix Bug fix, will increment patch version when merged (0.0.+1) labels Dec 19, 2024
Copy link

sourcery-ai bot commented Dec 19, 2024

Reviewer's Guide by Sourcery

This PR updates outdated documentation links across multiple files to ensure accurate redirection to the Neurobagel website resources. The changes primarily involve replacing segments of URLs with "user_guide" where appropriate, reflecting a restructuring of the documentation on the website.

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

File-Level Changes

Change Details Files
Updated documentation links in home.vue
  • Corrected the documentation links for the annotation tool, data preparation guide, term naming standards, and command-line interface usage within the home page content.
pages/home.vue
Updated documentation links in download.vue
  • Corrected the documentation links for the Neurobagel annotated .json data dictionary and command-line interface usage within the download page content.
pages/download.vue
Updated documentation links in README.md
  • Corrected the documentation and quickstart links for the annotation tool within the README file to reflect the updated website structure.
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

netlify bot commented Dec 19, 2024

Deploy Preview for neurobagel-annotator ready!

Name Link
🔨 Latest commit 5f9fec1
🔍 Latest deploy log https://app.netlify.com/sites/neurobagel-annotator/deploys/676490b39cfe550008ebe02a
😎 Deploy Preview https://deploy-preview-839--neurobagel-annotator.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@surchs surchs self-requested a review December 19, 2024 21:33
@alyssadai alyssadai self-assigned this Dec 19, 2024
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.

Thanks @alyssadai, good find!

I guess we don't have the link-checker in this repo? Shame.
Thanks also for PR labels, but annotation tool still needs manual release trigger. We will do that once all the neurobagel/planning#202 changes are merged.

🧑‍🍳

@alyssadai alyssadai removed release Create a release when this PR is merged pr-bug-fix Bug fix, will increment patch version when merged (0.0.+1) labels Dec 19, 2024
@alyssadai
Copy link
Contributor Author

@surchs, the link checker is specifically for markdown files, so I don't think it would work in this case. Maybe there's one for html files? 🤔

@alyssadai alyssadai merged commit 73f0438 into main Dec 19, 2024
11 checks passed
@alyssadai alyssadai deleted the alyssadai-patch-1 branch December 19, 2024 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Review - Done
Development

Successfully merging this pull request may close these issues.

2 participants