Docs v2

Edit

Contribute to the final push for releasing v2 of the nf-core documentation. Help with quality control, link fixes, and content refinement.

Goal

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.

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.

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