Overhaul documentation structure and content
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 98
- Forks
- 298
- Avg merge
- 14h 38m
- Merged PRs (30d)
- 38
Description
Is your feature request related to a problem? Please describe.
By far the biggest obstacle new and existing users are experiencing when either trying to onboard or to develop within nf-core is the suboptiomal documentation that has accumulated relatively organically over many years ^1.
Despite some improvements with the website replacement, many people are still finding the project documentation difficult to navigate and find the information they need - also finding critical information missing and/or out of date.
Describe the solution you'd like
We should a big overhaul the structure and content of the project documentation to ensure it is effective in giving a good user- and developer-experience.
We should target both users and developers, and follow a proper framework such as Diataxis (https://diataxis.fr) to ensure it is easy for people to add and extend documentation in a ordered and structured way.
[!NOTE]
This issue actually spans more than just the website, but putting it here due to the below - once we have a better plan an RFC will be made
Additional context
This includes many outstanding issues we have on this repo including:
- https://github.com/nf-core/website/issues/2821
- https://github.com/nf-core/website/issues/3057
- https://github.com/nf-core/website/issues/3248
- https://github.com/nf-core/website/issues/2693
- https://github.com/nf-core/website/issues/2372
- https://github.com/nf-core/website/issues/2134
- https://github.com/nf-core/website/issues/1614
- https://github.com/nf-core/website/issues/1255
- https://github.com/nf-core/website/issues/1250
- https://github.com/nf-core/website/issues/1101
- https://github.com/nf-core/website/issues/1099
- https://github.com/nf-core/website/issues/987
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 linked website issues and the Diataxis framework to map the documentation gaps affecting users and developers. The issue notes that an RFC should follow once there is a better plan; done means producing an agreed documentation structure and content-overhaul plan that addresses the identified gaps.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100