Documentation Refactoring Description

[AliceJoubert]

Description

The documentation of Clinica contains a lot of information scattered over different pages which can make it difficult for a user to navigate it or find relevant information. The aim of this work package is to simplify the documentation, make sure every command line is well described (options, outputs...) and instructions are clearly delivered.

Objectives

General

• Be able to re-use blocks of text in several places : snippets use example in [DOC] Adding Support page #1297

Converters to BIDS

Check for installation instructions, options description...

• ADNI
• AIBL
• GENFI
• HABS
• NIFD
• OASIS
• OASIS3
• UKB : [DOC] Refactor UKB-To-BIDS documentation page #1284

Pipelines :

Check for method description, options and outputs description...

• Fully describe options with snippets
• Anatomical linear : [DOC] Improve t1-linear documentation #1429 and [DOC] FLAIR documentation update #1442
• Anatomical volume
• Anatomical FreeSurfer
• DWI
• PET
• Statistics
• ML

IOTools

• Separate in different pages : [DOC] Fix warnings in documentation build #1435
• Review options/outputs :
  • [FIX][DOC] Modify the name of variables in the client and documentation to fit actual possibilities for create-subjects-visits #1437

Set-up

• Third-Party : [DOC] Refactor Third-Party documentation page #1288
• Installation : [DOC] Refactor Installation pages #1295
• Interacting with Clinica

[github-actions]

This issue is considered stale because it has not received further activity for the last 14 days. You may remove the inactive label or add a comment, otherwise it will be closed after the next 14 days.