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

Update documentation and miscellanous modification for release #164

Merged
merged 27 commits into from
Dec 2, 2024

Conversation

LouisLeNezet
Copy link
Collaborator

Fix the comment of @sofstam in #142

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/phaseimpute branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@LouisLeNezet LouisLeNezet requested a review from sofstam November 28, 2024 15:08
@LouisLeNezet LouisLeNezet self-assigned this Nov 28, 2024
@LouisLeNezet LouisLeNezet added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 28, 2024
@LouisLeNezet LouisLeNezet added this to the v0.99.0 milestone Nov 28, 2024
Copy link
Contributor

@sofstam sofstam left a comment

Choose a reason for hiding this comment

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

I made some suggestions before approving it.

docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/images/metro/legend.png Outdated Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
LouisLeNezet and others added 4 commits November 28, 2024 18:29
Co-authored-by: Sofia Stamouli <[email protected]>
Co-authored-by: Sofia Stamouli <[email protected]>
Co-authored-by: Sofia Stamouli <[email protected]>
Co-authored-by: Sofia Stamouli <[email protected]>
@LouisLeNezet LouisLeNezet requested a review from sofstam November 28, 2024 17:51
Copy link
Contributor

@sofstam sofstam left a comment

Choose a reason for hiding this comment

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

Looks good to me now!

Copy link
Collaborator

Choose a reason for hiding this comment

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

There are things that you suggested me change in the previous metro-map that are not reflected here. For example, "compute GL".

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll do it in a separate PR :)

@LouisLeNezet LouisLeNezet merged commit 05a2a4c into nf-core:dev Dec 2, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants