Add comprehensive project documentation#94
Closed
FIrgolitsch wants to merge 2 commits intomainfrom
Closed
Conversation
Adds 12 new docs/ files covering: GPU acceleration setup, library API reference, mosaic grid file format, Nextflow workflow guide, pipeline overview, performance analysis guide, reconstruction diagnostics, scripts reference, shifts CSV format, slice config feature, and slice interpolation feature documentation.
Contributor
Author
|
Closing in favour of #96 (recreated with squashed commits as part of the PR split plan refresh). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds 12 new Markdown files in
docs/covering all major aspects of the project. This PR is independent of all code PRs and can be merged at any time.New Documentation Files
docs/PIPELINE_OVERVIEW.mddocs/SCRIPTS_REFERENCE.mddocs/LIBRARY_MODULES.mddocs/GPU_ACCELERATION.mddocs/NEXTFLOW_WORKFLOWS.mddocs/MOSAIC_GRID_FORMAT.mddocs/SHIFTS_FILE_FORMAT.mddocs/SLICE_CONFIG_FEATURE.mddocs/SLICE_INTERPOLATION_FEATURE.mddocs/RECONSTRUCTION_DIAGNOSTICS.mddocs/PIPELINE_PERFORMANCE_ANALYSIS.mddocs/AI_DOCUMENTATION_INDEX.mdDependencies
None — can be merged at any time.