General Navigation Principles
- The wiki must function as a guided journey starting at the Quick Start and ending at the recipes.
- Every individual wiki page must conclude with a clear link or connection to the next logical step to ensure a continuous user experience.
Quick Start Section (Branching Paths)
- The Quick Start acts as a central hub with branching paths tailored to different user goals.
- Users can choose to navigate to fundamental setup guides encompassing installation, configuration, and execution.
- Users can branch to instructions on utilizing modules in isolation.
- Users can navigate to a section detailing the recommended approach of using loaded modules in projects via Snakemake workflows.
- Users can jump directly to developer-focused guidelines for building custom MrBiomics modules.
Core Documentation (Linear Path)
- Beyond the branching Quick Start, the primary documentation must follow a structured, linear progression.
- The linear path begins with foundational setup: installation, configuration, and execution.
- It sequentially advances to the practical application of modules within projects.
- The guide then explicitly explains the usage of rules.
- From the rules section, users are guided to recipes, offering them the choice to complete them in a sequential order for an interconnected project, or to jump to individual recipes of interest.
Developer Guidelines & Best Practices
- A dedicated final section must exist for users intending to create their own MrBiomics modules.
- This section must clearly outline the specifications and requirements that custom modules need to fulfill.
- It must emphasize strict adherence to best practices to guarantee module composability.
Transcript
The MrBiomics wiki should be a guide that starts from the Quick Start and ends with the recipes. Improve the wiki so that there is always a connection to the next step at the end of each page. The Quick Start can branch out: if you want to learn more about installation, configuration, and execution, go here. If you want to see how to use modules in isolation, go here. If you want to use modules in your projects as Snakemake workflows (loaded modules—this needs to be formulated better), go here, and add in brackets that this is the recommended approach.
After showing how to use workflows or modules in projects, the next natural step is to explain how to use rules. At the end of that section, indicate that users can go to the specific rule they are interested in. They can either go through the rules in order, as they build an interconnected project, or jump directly to a specific recipe. Finally, if you want to build your own modules and adhere to MrBiomics specifications, go here to ensure best practices and composability. This last point can also be placed at the end of the Quick Start.
Thus, the Quick Start acts as a branching point towards learning the basics, using modules in projects, using recipes, and developer best practices. The other points should follow a more linear progression: installation, configuration, execution, modules in projects, how to use recipes, the recipes themselves, and finally, how to build a MrBiomics module and what requirements it must fulfill.
General Navigation Principles
Quick Start Section (Branching Paths)
Core Documentation (Linear Path)
Developer Guidelines & Best Practices
Transcript
The MrBiomics wiki should be a guide that starts from the Quick Start and ends with the recipes. Improve the wiki so that there is always a connection to the next step at the end of each page. The Quick Start can branch out: if you want to learn more about installation, configuration, and execution, go here. If you want to see how to use modules in isolation, go here. If you want to use modules in your projects as Snakemake workflows (loaded modules—this needs to be formulated better), go here, and add in brackets that this is the recommended approach.
After showing how to use workflows or modules in projects, the next natural step is to explain how to use rules. At the end of that section, indicate that users can go to the specific rule they are interested in. They can either go through the rules in order, as they build an interconnected project, or jump directly to a specific recipe. Finally, if you want to build your own modules and adhere to MrBiomics specifications, go here to ensure best practices and composability. This last point can also be placed at the end of the Quick Start.
Thus, the Quick Start acts as a branching point towards learning the basics, using modules in projects, using recipes, and developer best practices. The other points should follow a more linear progression: installation, configuration, execution, modules in projects, how to use recipes, the recipes themselves, and finally, how to build a MrBiomics module and what requirements it must fulfill.