Revise README for clarity and updated project details#23
Open
rapsoj wants to merge 1 commit into
Open
Conversation
Refactor README to enhance clarity and structure, including updates to project goals, pipeline status, and repository structure.
smodee
reviewed
May 20, 2026
Collaborator
smodee
left a comment
smodee
left a comment
There was a problem hiding this comment.
Looks like a solid improvement overall. Just noted that some top level directories listed in the repo structure tree are not in the repo (yet?):
- configs/
- docs/
- notebooks/
- tests/ (we currently have tests in bioscancast/tests/)
Not requesting change, just flagging. Will approve after you confirm intended structure.
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.
Refactor README to enhance clarity and structure, including updates to project goals, pipeline status, and repository structure.