Skip to content

docs: update output directory structure to reflect naming refactor#139

Merged
akhanf merged 3 commits intomainfrom
copilot/update-documentation-output-file-renaming
Mar 31, 2026
Merged

docs: update output directory structure to reflect naming refactor#139
akhanf merged 3 commits intomainfrom
copilot/update-documentation-output-file-renaming

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 31, 2026

The large naming refactor split outputs across multiple typed subdirectories instead of placing everything under micr/. Documentation still showed the old flat micr/ structure for all outputs.

Updated docs

  • docs/reference/outputs.md — Replaced single-folder diagram with accurate multi-folder tree; added per-folder sections describing each output type; fixed .nii.nii.gz for group volume maps
  • docs/faq.md — Updated "Where are my results?" to show the new structure with inline folder descriptions
  • docs/getting_started/quickstart.md — Updated Step 5 output tree with realistic filenames and corrected key-files list

New output structure

output/spimquant/
├── sub-01/
│   ├── micr/       # registered NIfTIs + masks + regqc HTML
│   ├── seg/        # full-res segmentation OME-Zarr
│   ├── parc/       # atlas dseg NIfTIs  (was micr/)
│   ├── tabular/    # segstats, regionpropstats, fieldfracstats, countstats  (was micr/)
│   └── xfm/        # affine + deformable transforms
└── group/          # groupstats TSV/PNG/NIfTI

Copilot AI changed the title [WIP] Update documentation for output file renaming changes docs: update output directory structure to reflect naming refactor Mar 31, 2026
Copilot AI requested a review from akhanf March 31, 2026 01:21
Base automatically changed from naming-refactor to main March 31, 2026 01:40
Updated output directory structure and corrected file extensions in the documentation.
@akhanf akhanf marked this pull request as ready for review March 31, 2026 01:44
@akhanf akhanf merged commit 36be332 into main Mar 31, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants