Update documentation - Githubissues

monarch-initiative / monarch-app

Monarch Initiative website and API

https://monarchinitiative.org/

BSD 3-Clause "New" or "Revised" License

18 stars 6 forks source link

Update documentation #893

Closed ptgolden closed 2 days ago

ptgolden commented 1 week ago

Summary

Renames docs page to "Monarch KG Tools"
Moves release-process.md from https://github.com/monarch-initiative/monarch-documentation/blob/main/src/docs/release-process.md into these docs
Updates CLI documentation after changes made in 64b4d01f
Folds the existing "Welcome", "Usage", and "Response Data Model" sections into one broader section for "monarch-py"
Removes the "API Reference" section, as it is redundant with information already contained in "Usage"

Related issues

Closes #820
[ ] All tests have passed (or issues created for failing tests)

netlify[bot] commented 1 week ago

Deploy Preview for monarch-app ready!

Name	Link
Latest commit	4e579e5160d84ea94d2dd1c790e439bfb87b0e0b
Latest deploy log	https://app.netlify.com/sites/monarch-app/deploys/673e16377c266a0008b3c082
Deploy Preview	https://deploy-preview-893--monarch-app.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 71.14%. Comparing base (1a1350d) to head (4e579e5). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #893 +/- ## ======================================= Coverage 71.14% 71.14% ======================================= Files 91 91 Lines 3136 3136 ======================================= Hits 2231 2231 Misses 905 905 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

ptgolden commented 1 week ago

@kevinschaper Do you want to check out this PR, build the docs, and see if this organization is to your liking?

kevinschaper commented 2 days ago

@ptgolden it looks like this needs a slightly more careful merge to handle renaming entity to entity_id