Validate output files using the new output syntax in documentation
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 322
- Forks
- 255
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 5
Description
Description of feature
With the new output syntax and all that comes with it, like lineage records in the very near future, we can start validating the documentation that pipelines provide on the output. I think we have multiple levels or different routes we could take:
- Validate all files in the current results tab on the website are listed
- Have an output schema and generate a new tab, similar to the params tab. Auto-populating and writing would make it even easier. Also LLM friendly
https://nfcore.slack.com/archives/CE5LG7WMB/p1781521587495859
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the new output syntax and the linked Slack discussion. Clarify whether the goal is validating files listed in the website's current results tab or defining an output schema that generates a new tab. Done should include an agreed validation scope and documented acceptance criteria for the selected approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100