BlueBrain / BlueBrain/nexus

Change documentation structure to include how-tos and more tutorials

Open
#2,756 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Scala
Stars
301
Forks
76
PR merge metrics
No merged PRs in 30d

Description

Documentation system: https://documentation.divio.com/

Example:

![image](https://user-images.githubusercontent.com/11705901/131875459-049ceeb4-9c3a-4942-9b68-e86dd565f4d4.png)
Source: https://www.gatsbyjs.com/docs/

Contributor guide

Open the contributing guide

Research direction

Start by reading the linked Divio documentation system and comparing its how-to and tutorial structure with the Gatsby documentation example. Then inspect the repository's current documentation organization; done means the structure clearly includes how-tos and tutorials in a consistent arrangement.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.