Goal
Help us work towards completing the final quality control phase of the nf-core documentation v2 release by fixing links, filling content gaps, and helping the documentation meet our new standards.
Description
James and Chris have almost completed the migration of existing documentation into the new styled documentation set. Content has been migrated using the newly developed style guide and structure to make finding what you need more intuitive.
Check out the docs-v2 deploy preview.
This project focuses on the critical quality control phase of the migration before we replace the current documentation:
- Fixing broken or outdated links throughout the documentation
- Identifying and filling content gaps discovered during migration
- Reviewing migrated content for clarity and consistency
- Validating that the new structure works effectively
- Polishing documentation that does not meet the new quality standards
- Creating new content to fill gaps
Our goal is to merge the new and improved documentation at the end of the hackathon.
Tasks
With the rapid initial migration complete, we need careful review and refinement to help make the v2 documentation launch as successful as possible and improve the user experience.
We need as many eyes on the docs as possible to help us with quality control. We realise that not everything will be perfect for the iniital release, but would like to get as close as we can.
This project is suitable for newcomers to nf-core and open source contributions. We expect to have many “great first issues” available to help you get started.
Specific tasks include:
- Review sections for broken links and fix them
- Identify and document content gaps
- Review migrated content for quality and consistency
- Test navigation and documentation structure
- Create new content to fill identified gaps
- Validate examples and code snippets
- Ensure style guide compliance across pages
For a list of open issues, see Website issues.
If you find other issues you would like to work on, please make them into GitHub issues for visibity.
Making PRs
All updates should be made against the docs-v2 branch.
As we are pushing towards a major release of documentation and will not be strictly following the standard nf-core review protocols, leave merges open for James or Chris to reivew and merge. Tag them for reviews as you make the PRs.
Chris will largely be working in New Zealand time, while James will be working in European time. There may be a delay in resonse to your PR.
