docs(gks-vignettes): add GA4GH GKS Starter Kit vignettes doc tree#698
Draft
bencap wants to merge 1 commit into
Draft
docs(gks-vignettes): add GA4GH GKS Starter Kit vignettes doc tree#698bencap wants to merge 1 commit into
bencap wants to merge 1 commit into
Conversation
- Four vignettes covering VRS identity, cross-score-set harmonization,
Cat-VRS categorization, and VA-Spec functional evidence sharing
- Standalone MkDocs site under ui/docs-gks-vignettes/ for internal
preview before upstream contribution to ga4gh/gks-starter-kit
- use_directory_urls: false to match main docs and fix static serving
- JSON payload blocks wrapped in collapsible details admonitions;
large VA-Spec pathogenicity statement collapsed by default, smaller
payloads expanded
This file contains hidden or 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
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 a standalone MkDocs site (ui/docs-gks-vignettes/) containing four GA4GH GKS Starter Kit vignettes documenting how MaveDB uses VRS, Cat-VRS, and VA-Spec in production.
This is an internal preview, not a shipping commitment. The PR is here for feedback on the content and to figure out what we actually want to do with these. See https://staging.mavedb.org/docs/gks-vignettes/index.html for what these vignettes will look like when submitted to GA4GH.
What's here
Four vignettes, each a real implementation walk-through:
The JSON payloads are real exports from the MaveDB API. Large blocks (the 1,332-line GCK pathogenicity statement in particular) are collapsible.
Some of these stories are still aspirational, but all are tractable and in development.
Open question: how visible should these be for MaveDB users?
At minimum we should:
A few options specific to MaveDB consumers:
I lean towards contributing upstream, linking from our docs, and deleting the local copy. The content seems useful to me but the maintenance burden of duplicating them seems unnecessary even if we lose a little discoverability and consistency in documentation style.
If we go with the link out, we can open this PR in the GKS repo and repurpose this one for link outs once accepted.
LMK of any feedback on the content itself: