[ENH] Create a glossary for unclear terms #138
Merged
Conversation
This file contains 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
✅ Deploy Preview for neurobagel-documentation ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
11 tasks
- combined two files - added updated definitions - added synonyms
alyssadai
approved these changes
Dec 20, 2023
There was a problem hiding this comment.
Thanks again @surchs for all your work on this!!
I've left another round of 🍒 edits as I realize, looking at the deploy preview, that the definitions for several terms are still quite long and some info could probably work better as admonitions.
Feel free to accept what makes sense to you!
Co-authored-by: Alyssa Dai <alyssa.ydai@gmail.com>
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.
Closes #44
Changes proposed in this pull request:
Each term is a 3rd level subheading. This allows us to use the sidebar navigation and we can also create links from inside the documentation to these terms. I am not sure that there is an automatic way to create these links - and I also don't think that we'd want that.
For reviewer: to keep this PR manageable, let's treat it more as a collaborative writing exercise: please provide direct edit suggestions where needed. For more substantial changes or additions let's create new issues.
Checklist
[ENH],[FIX],[REF],[TST],[CI],[MNT],[INF]) (see https://neurobagel.org/contributing/pull_requests for more info)Closes #XXXX