Documentation has been changed to mkdocs and readme has been reduced#44
Merged
Conversation
Add full MkDocs documentation following the SigProfilerAssignment structure: home page, installation, quick start example, workflow, input parameters, and output description. Includes Material theme config, OSF TOC hook, extra CSS, and GitHub Actions workflow for automated deployment to GitHub Pages. Update citation in README to published Bioinformatics paper and add Nature 2022 paper as second reference.
Add SigProfilerClusters logo (56 KB) to README and documentation. Update docs.yml to deploy only from master and bump all action versions to their latest releases.
marcos-diazg
approved these changes
May 8, 2026
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
2 participants
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.
No description provided.