[DOCS] Reorganize documentation #56
Merged
Conversation
This file contains 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
tsalo
reviewed
Aug 16, 2024
tsalo
reviewed
Aug 16, 2024
docs/changes.rst
Outdated
There was a problem hiding this comment.
How do you feel about copying over the release notes before making each release, like I do with XCP-D? https://xcp-d.readthedocs.io/en/latest/changes.html
There was a problem hiding this comment.
In the past I've had trouble keeping this in sync with the github releases page. Do you have a system for keeping these all consistent?
There was a problem hiding this comment.
Here's my workflow:
- Use the "Generate Release Notes" button on a draft release on GitHub.
- Add some context to the release notes.
- Save the release as a draft.
- Copy the release notes to the CHANGES.rst file and update the CITATION.cff file in a new PR.
- Merge the PR.
- Make the new release.
It's a little annoying, but it gets the release notes into the CHANGES file.
tsalo
reviewed
Aug 16, 2024
tsalo
reviewed
Aug 16, 2024
tsalo
reviewed
Aug 16, 2024
* Add report config files. * Remove viz submodule. * Work on nireports. * Add viz utils back in. * More work. * Fix import. * Remove reportlets_dir. * Try to fix things. * Add qsirecon_suffix info. * Update core.py * Update run.py * Update expected outputs. * Update run.py * Update. * Update test_cli.py * Update run.py * Update expected outputs. * Update workflow.py * Update. * Fix.
* Drop the Docker and Singularity wrappers. * Keep dropping wrappers.
* Add ng, perng, and parng to outputs. * Only calculate with non-aniso? * Update dipy.py * Update test_cli.py * Update. * Update dipy_mapmri_outputs.txt
Co-authored-by: Taylor Salo <[email protected]>
* Drop the Docker and Singularity wrappers. * Keep dropping wrappers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
QSIRecon needed a major overhaul of the documentation, especially for the recently-added mapping workflows.