---
# System prepended metadata

title: Nilearn User Guide (Re-)Outline
tags: [Nilearn]

---

# Nilearn User Guide (Re-)Outline

## New section ordering

1. introduction @Alexis
2. [X] manipulation @Hao-Ting (Reordering needed, add content on surface data, can move data fetching to different section)
3. plotting @Jerome
4. glm @Yasmin (I think content is good and flows nicely through the 3 sections, maybe 2nd level models can be expanded)
5. [x] connectivity @Alexis (nice content, could be slightly reworked)
6. decoding @Bertrand
7. advanced @Elizabeth

- Within sub-sections, conserve advanced material until the end of the sub-section
- Read through sub-sections to determine order and relevant appropriateness of material for target audience

## Target audience

- Under-grad and grad students
    - with a CS/ML background
    - or with a computational-bio, neuroscience background

## Revisting structural elements

UI/UX guidelines
- think mobile-first
- 1 column only
- minimal use of indented content
    - try to keep nested indentations as low as possible because they render poorly
- select a limited number of UI components from Furo
    - admonitions (https://pradyunsg.me/furo/kitchen-sink/admonitions/)
        - I (@Alexis) suggest we only keep
            - warning (content users should absolutely read)
            - note (important content that needs to be stressed, but that is not a warning)
    - code-blocks
        - use `.. code-block:: default`

Content / redaction guidelines
- simple vocabulary
- short sentences
- less text is better
- add images everytime they ease understanding
- don't repeat examples, reference them instead

## Section-specific notes

### Introduction

- Remove the installation subsection
    - [x] Move out intro paragraph from MVPA subsection
    - [x] Change header
        - _Why use nilearn? What is nilearn?_
    - [x] State library use cases
