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 doc website with more FAQs and expect output tab #156

Merged
merged 7 commits into from
Aug 26, 2024
Merged

Conversation

samarth8392
Copy link
Contributor

@samarth8392 samarth8392 commented Aug 22, 2024

Changes

  • Updates the FAQs with instructions on how to use snakemake.log.jobby.short
  • Removed references to RNA-seek from troubshooting.md
  • Updated GUI instructions image with renee gui instead of renee_gui
  • Added Expected Output tab to doc website

Issues

Resolves #146
Resolves #147

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
    - [ ] Update docs if there are any API changes.
  • Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

@kopardev kopardev added the RENEE RepoName label Aug 22, 2024
@samarth8392
Copy link
Contributor Author

@kopardev @kelly-sovacool Can either of you take a look at the updated FAQs (troubleshooting.md) and the expected output documentation I have added. Let me know if they look good or do I need to revise the docs.

@samarth8392 samarth8392 marked this pull request as ready for review August 22, 2024 21:24
Copy link
Member

@kelly-sovacool kelly-sovacool 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 @samarth8392, just a couple minor suggestions

docs/troubleshooting.md Outdated Show resolved Hide resolved
docs/troubleshooting.md Outdated Show resolved Hide resolved
@kelly-sovacool
Copy link
Member

I changed the changelog entry to use the PR number instead of the issue numbers, and also updated your initial PR comment to use "Resolves" for each issue so they will be closed when this is merged.

@samarth8392 samarth8392 merged commit 181a4bf into main Aug 26, 2024
5 checks passed
@samarth8392 samarth8392 deleted the doc-faqs branch August 26, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
RENEE RepoName
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: FAQ on searching for failed jobs in log files docs: describe outputs
3 participants