Update documentation #893
Merged
Update documentation #893
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
added 6 commits
November 15, 2024 10:09
-o is typically the flag for outputting to a file, but it's best not to change what's already there. Additionally, a couple commands take -o as a different command line option for specificying objects
There are a number of changes here that come as a result of 64b4d01. Namely: the docstring of arguments are removed in favor of pulling help from typer arguments and options.
This adds a new section to the navigation bar ("Release process"), and
merges the previous "Welcome" and "Usage" pages into a "monarch-py"
section.
✅ Deploy Preview for monarch-app ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #893 +/- ##
=======================================
Coverage 71.14% 71.14%
=======================================
Files 91 91
Lines 3136 3136
=======================================
Hits 2231 2231
Misses 905 905 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
This commit does two things to complete the collection of all monarch-py documentation into a single section in the main documentation. It does the following: 1. Remove "API Reference" section. The information there is in the "Interfaces" and "Implementations" subsections of the monarch-py documentation. 2. Moves the "Response Data Model"-- which contains documentation generated from LinkML models-- into a "Data Model" subsection in monarch-py. Besides the CLI documentation, the monarch-py documentation is a bit jumbled and obviously needs some attention and changing. It's not quite clear coming to the page how someone might use the package as a python package. That is a broader issue, and not one we need to focus on right now, since it's not clear that anyone but the Web application actually uses the monarch-py code.
|
@kevinschaper Do you want to check out this PR, build the docs, and see if this organization is to your liking? |
3 tasks
kevinschaper
approved these changes
Nov 19, 2024
|
@ptgolden it looks like this needs a slightly more careful merge to handle renaming entity to entity_id |
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.
Summary
release-process.mdfrom https://github.com/monarch-initiative/monarch-documentation/blob/main/src/docs/release-process.md into these docsRelated issues
Closes Move the Monarch KG Release process page to the Monarch-app documentation #820
All tests have passed (or issues created for failing tests)