[STORY] Rework pipeline autodocs based on feedback - Githubissues

ArcanaFramework / arcana

Abstraction of Repository Centric ANAlysis

Other

4 stars 5 forks source link

[STORY] Rework pipeline autodocs based on feedback #120

Closed tclose closed 2 years ago

tclose commented 2 years ago

Description

@civier has provided some constructive feedback on the layout of the auto-generated documentation, https://github.com/Australian-Imaging-Service/arcana/blob/main/docs/fmriprep._.Australian.Imaging.Service-OC.pdf. We should go through it and decide how best to respond to the feedback

Acceptance Criteria

[x] 1. known issues section pulled from YAML
[x] 2. Remove workflow and executable from commands section
[x] 3. Add display name attribute for formats to user-readable formats
[x] 4. Add descriptions for the parameters
[x] 5. Add 'description' key to licenses YAML, so where the license can be obtained from can be added
[x] 6. Remove "mounted at" from licenses section

tclose commented 2 years ago

remaining work split out into #201 and #200