-
Notifications
You must be signed in to change notification settings - Fork 6
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
[REF] Create custom paths for user guide and data model pages, refactor section on local_nb_nodes.json
#242
Conversation
…ories - update relative paths in files
✅ Deploy Preview for neurobagel-documentation ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
local_nb_nodes.json
local_nb_nodes.json
local_nb_nodes.json
Reviewer's Guide by SourceryThis PR reorganizes the documentation structure by creating dedicated subdirectories for User Guide and Data Model pages, and improves the readability of the node configuration documentation. The changes primarily involve moving files into new directories and updating internal documentation links to reflect the new structure. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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 and they look great!
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
Hi @alyssadai! 👋
@sourcery-ai is now installed on this repository.
We found this recent PR of yours and reviewed it to show you what Sourcery can do.
If you want to review another PR, just comment with @sourcery-ai review
✨
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @alyssadai, this looks great
🧑🍳
Co-authored-by: Sebastian Urchs <[email protected]>
…ocumentation into refactor-user-guide
local_nb_nodes.json
to something more informative #241Changes proposed in this pull request:
overview.md
into a section index page for the User Guide section (so now, you can navigate to https://neurobagel.org/user_guide directly)Checklist
Please leave checkboxes empty for PR reviewers
[ENH]
,[FIX]
,[REF]
,[TST]
,[CI]
,[MNT]
,[INF]
) see our Contributing Guidelines for more info)Closes #XXXX
Summary by Sourcery
Refactor documentation structure by creating custom paths for User Guide and Data Model pages, and improve the section on 'local_nb_nodes.json' for clarity.
Enhancements:
Documentation: