Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Splitting up README.md into several documents, all found in the docs folder #152

Merged
merged 38 commits into from
Jan 27, 2025

Conversation

harmonbhasin
Copy link
Collaborator

I'm not done as yet, however I'd like some feedback! I've added my notes on where I think each doc is below. Please suggest restructuring or removing documents if you don't think they're helpful.

  • README.md - I'm not sure what we should update this to be, we can have a table of contents for the doc, but I'm not sure what else would be helpful, your input here would be useful.
  • docs
    • batch.md - I think this is pretty much done.
    • run_validation.md - Near finished, want to clean up summary at beginning before figure.
    • run.md - Near finished, considering putting output files and if so, need to figure out the best way to show it; need to clean up the main summary
    • overview.md: I think this is pretty much done
    • troubleshooting.md: I think this is pretty much done
    • usage.md: Need to clean up the compute resources requirement section.
    • faqs.md: We should have more questions here, but for now, I'm fine leaving it with these questions.
    • developer.md: I think the content is good, but I'll want to rearrange this structure using claude
    • installation.md: I think this looks pretty good.
    • output.md: I think this is near finish, other than adding run_validation
    • index.md: I need to do this, although this shouldn't take long, and it shouldn't block you from looking at the other files, expect this to look similar to run.md

@harmonbhasin
Copy link
Collaborator Author

I probably should have merged this into another branch so that the tests didn't run, but I decided to just shut them of manually so that we don't waste minutes.

docs/output.md Outdated
### `results`

#### `qc`
- `total_reads_qc.tsv.gz`: Total number of reads processed at each stage of the preprocessing phase (`stage`)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to update this description.

@willbradshaw willbradshaw changed the base branch from dev to docs_dest January 22, 2025 19:52
@willbradshaw willbradshaw changed the base branch from docs_dest to dev January 22, 2025 19:52
docs/batch.md Outdated Show resolved Hide resolved
Copy link
Contributor

@willbradshaw willbradshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still reviewing, but here are some initial comments on what seem to me to be the most important files


Clone this repo into a new directory as normal.

#### 4. Run index/reference workflow
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have new users run the test suite? That would be a good way to check that the pipeline works in their hands. But maybe we can't be sure their launcher instance will have enough resources to actually run the test suite?

That actually brings up a different topic: we should probably provide some guidance on what size instance is needed to run the pipeline on Batch. @harmonbhasin do you already do this somewhere?

docs/installation.md Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/run.md Outdated Show resolved Hide resolved
docs/run.md Outdated Show resolved Hide resolved
docs/run.md Outdated Show resolved Hide resolved
docs/run.md Outdated Show resolved Hide resolved
docs/run.md Outdated Show resolved Hide resolved
@harmonbhasin harmonbhasin changed the base branch from dev to harmon_trunc_docs January 23, 2025 15:16
@harmonbhasin
Copy link
Collaborator Author

There wasn't documentation for run_validation workflow before, do we want to add this for this pull request? @willbradshaw

@harmonbhasin
Copy link
Collaborator Author

@willbradshaw this is ready for you to look at!

Copy link
Contributor

@willbradshaw willbradshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple minor comments to resolve, then we're good to go!

docs/run.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
@willbradshaw willbradshaw merged commit b60a920 into harmon_trunc_docs Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants