This repository has been archived by the owner on Nov 6, 2020. It is now read-only.
Documentation touchup #75
Open
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
Damien-Black
suggested changes
Aug 21, 2019
There was a problem hiding this comment.
Some review comments inline. Some initial thoughts on the structure of the page:
- Parliament2
- Running parliament locally
- Prereqs
- Installing
- Running
- ...other relevant h3
- Running Parliament2 on DNAnexus
- Prereqs
- Installing (This may just link to creating an account page)
- Running
- ...other relevant h3
- More information
- etc...
- Running parliament locally
The Readme should have similar flows to local/platform/etc... setups to improve readability.
| "doi:10.1186/gb-2014-15-6-r84", | ||
| "doi:10.1093/bioinformatics/btv710", | ||
| "doi:10.1038/nmeth.3505", | ||
| "doi:bioinformatics/btv478", |
There was a problem hiding this comment.
Doesn't resolve on https://www.doi.org/. Just double-check in the UI
| @@ -7,7 +7,7 @@ | |||
| "WGS" | |||
| ], | |||
| "dxapi": "1.0.0", | |||
| "version": "0.1.11", | |||
| "version": "0.1.11a", | |||
There was a problem hiding this comment.
I don't think 0.1.11a follows the semver spec. Is the a meant to be a pre-release modifier?
Co-Authored-By: Steve Osazuwa <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Update documentation links and add license information for the SV callers used.