docs: expand release_candidate2 documentation - #151
Draft
mattloose wants to merge 34 commits into
Draft
Conversation
ci: add MkDocs PR preview workflow
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
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
Reworks and expands the documentation for
release_candidate2so the MkDocs site is the canonical user/developer documentation and first-time users have a much clearer path through the project.First-run documentation
Analysis and developer documentation
release_candidate2, including ITD and TUCANRepository cleanup
git-lfsconda dependency; the current branch has no LFS-tracked pathsScope
The application and analysis implementation are unchanged. The only non-documentation codebase change is removal of the unused
git-lfspackage fromrobin.yml.The documentation explicitly distinguishes model/heuristic outputs from standalone clinical interpretation and describes the incremental per-sample processing model used by ROBIN.