docs: Check links - Githubissues

iRNA-COSI / APAeval

Community effort to evaluate computational methods for the detection and quantification of poly(A) sites and estimating their differential usage across RNA-seq samples

MIT License

13 stars 14 forks source link

docs: Check links #42

Open ninsch3000 opened 3 years ago

ninsch3000 commented 3 years ago

Go through all README and other documentation files and check for missing/broken links, unclear explanations etc. Either fix yourself or reach out on Slack to clarify how to fix. Create new issues that might arise, if applicable.

federicomarini commented 3 years ago

If most info is encoded in text-based files, I can recommend awesome_bot to check these in a programmatic way -> https://github.com/dkhamsing/awesome_bot

uniqueg commented 3 years ago

I have manually checked the links in the main README.md file in the repository root. Found two swapped links and fixed them.

Still need to go through other documentation files:

[ ] docs/templates/snakemake/README.md
[ ] docs/templates/nextflow_dsl1/README.md
[ ] execution_workflows/README.md
[ ] execution_workflows/execution_output_specification.md
[ ] summary_workflows/parameter_codes.md

But might be good to run the awesome_bot first that @federicomarini recommended