docs: remaining unaddressed pages for docs-v2 overhaul
Open
A pull request for this has already been merged.
- #4094 by @jfy133 — merged
docs-version-2
documentation
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
The following pages have not been migrated, replaced, or been official marked for deprecation:
Writing modules/components tutorial-like pages
- https://nf-co.re/docs/tutorials/nf-core_training/writing-nf-core-modules/chapter-1-introduction (and companion pages)
- https://nf-co.re/docs/tutorials/nf-core_components/components
- Note: it is more detailed that https://docs-v2--nf-core-docs.netlify.app/docs/developing/components/creating-components, but not as detailed as https://nf-co.re/docs/tutorials/nf-core_training/writing-nf-core-modules/chapter-1-introduction
Test related pages
- https://nf-co.re/docs/contributing/nf-test/assertions
- https://nf-co.re/docs/tutorials/tests_and_test_data/nf-test_comprehensive_guide (and companion pages)
- https://nf-co.re/docs/tutorials/tests_and_test_data/test_data
- Half-superseded by the specifications documentation: https://docs-v2--nf-core-docs.netlify.app/docs/specifications/test-data/overview but has additional field-specific guidance
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 opening the listed components, assertions, nf-test comprehensive guide, and test_data pages, then compare them with the linked docs-v2 pages where provided. Check the merged pull request for the current migration status. Done means each remaining page is migrated or replaced, or is officially marked for deprecation, with the checklist updated.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100