Chado buddy documentation #90
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
dsenalik
added
the
TOPIC: Extending Tripal
27 tasks
laceysanderson
requested changes
Sep 23, 2024
There was a problem hiding this comment.
General Comments
- To me ChadoBuddies docs should be under "Biological Data Storage" as it's specific to working with Chado and is at an API level versus a concrete deliverable level 🤷♀️ That said, maybe the menu layout needs a bit of a rework 🤔 See issue Restructure menu within "Extending Tripal" #94 for my thoughts on this.
- This documentation reminds me a lot of the old API docs. I think we want to keep these sections more tutorial/theory with examples interspersed. So an example of that might be the following sections for a ChadoCvtermBuddy where each has a small bit of text explaining examples.
- Overview/Purpose
- Inserting cvterms
- Retrieving existing cvterms
- Updating existing cvterms
- Associating cvterms
- Note: We'll have full API docs as well as soon as I find time to figure out how to generate them in Drupal 10.
|
I have updated the screenshots to reflect the current PR status |
Co-authored-by: Lacey-Anne Sanderson <[email protected]>
Co-authored-by: Lacey-Anne Sanderson <[email protected]>
Co-authored-by: Lacey-Anne Sanderson <[email protected]>
laceysanderson
approved these changes
Nov 18, 2024
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.
This adds documentation for all of the Chado Buddies from Tripal PR tripal/tripal#1844 and tripal/tripal#1938
I included one small unrelated fix so that the docs would build cleanly, this is in commit b24bd0e
Screenshots as of Oct 21
