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

324 improve the pipeline description #325

Merged
merged 20 commits into from
Jun 20, 2024
Merged

Conversation

mhkc
Copy link
Collaborator

@mhkc mhkc commented Jun 13, 2024

Description

This PR reworks the pipeline documentation.

Primary function of PR

  • Hotfix
  • Minor functionality improvement
  • Major functionality improvement / New type of analysis
  • Backward-breaking functionality

Testing

Either describe a procedure, or add data; that confirms that the PR resolves what it sets out to do

Sign-offs

@mhkc mhkc linked an issue Jun 13, 2024 that may be closed by this pull request
@mhkc mhkc marked this pull request as ready for review June 18, 2024 08:12
@mhkc mhkc requested a review from a team as a code owner June 18, 2024 08:12

| Species | Development status |
|------------------------------|--------------------|
| *Staphylococcus arueus* | Draft |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you reckon this is true? Should we not say beta?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The exact nomenclature doesnt matter to me. But I think draft is perhaps more expressive than beta. We also define the difference between the different statuses in the text as well.

Copy link
Collaborator

@svartapaerlan svartapaerlan left a comment

Choose a reason for hiding this comment

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

LGTM!

docs/source/overview.md Outdated Show resolved Hide resolved
docs/source/overview.md Outdated Show resolved Hide resolved
docs/source/install.md Outdated Show resolved Hide resolved
docs/source/overview.md Outdated Show resolved Hide resolved
docs/source/useage.md Outdated Show resolved Hide resolved
mhkc and others added 5 commits June 18, 2024 10:50
Co-authored-by: Ryan James Kennedy <rjkennedy69@gmail.com>
Co-authored-by: Ryan James Kennedy <rjkennedy69@gmail.com>
@mhkc mhkc merged commit 25c92eb into master Jun 20, 2024
3 checks passed
@mhkc mhkc deleted the 324-improve-the-pipeline-description branch June 20, 2024 12:20
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.

Improve the pipeline description Create readthedocs for pipeline containing software used in pipeline
2 participants