Hi team, I’d like to help reduce common support re...
# rnaseq_dev
k
Hi team, I’d like to help reduce common support requests by adding a "Troubleshooting & Common Errors" guide to the
nf-core/rnaseq
docs. The goal is to provide a quick "pre-flight" checklist for frequent issues like samplesheet formatting, genome/GTF mismatches, and container errors. I'm happy to draft a PR—does this align with your current documentation goals, or is there a preferred format you'd like me to follow?
👍🏻 1
p
Nice idea!
See pipelines like #CEQBS091V and #CGFUX04HZ for examples of how multi-page documentation renders on the website.
j
HEhehe, @Chris Hakkaart;)
We've been having debates this too actually @KANISHK in the docs team
🫠 1
c
This came up recently somewhere else as well 😅
j
The original pipeline to add the subpages that I know of was #C03PADVJ8RL , where you make a directory called 'usage/' where you add the subpages, and then link to that from the root
usage.md
.
But basically we want to overhaul the readme/usage docs structure anyway
And I feel quite strongly about adding exactly what you propose
For context this is what we discussed in the last #C09H9L3R614 meeting:
image.png
Which is what we will make a prototype on
p
#C09H9L3R614 recruitment! 😅
😬 1
100 rainbow 1