Monarch generates a number of QC and documentation artifacts each release including:
- Solr pivot tables ({source, taxa} x {association, relation}) as markdown
- Namespace, relation, namespace graphs as graphviz and markdown tables
- SciGraph category diffs as markdown
- Monarch rule violations as markdown
- Biolink schemas as graphviz
This vuepress app is built by slurping up these various resources documents and displaying them in a centralized dashboard, which also includes plotly heatmaps of solr pivot tables.
The app runs off of github pages and is hosted on https://qc.monarchinitiative.org/
A makefile is included to download the various files:
make
To run the vuepress app locally
VuePress requires Node.js >= 8.6:
With yarn:
yarn dev
Or with npm
npm install
npm run dev
To build the docs directory for production
yarn build
or
npm run build
To deploy to github pages (builds docs directory and pushes to github):
./deploy.sh
For more details on vuepress, please head VuePress's documentation.