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.

Sign up for GitHub

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

Jump to bottom

docs todos #78

Open
WardDeb opened this issue Oct 26, 2022 · 2 comments
Open

docs todos #78

WardDeb opened this issue Oct 26, 2022 · 2 comments
Assignees
@dkoppstein
Labels
documentation Improvements or additions to documentation

Comments

@WardDeb
Copy link
Member

WardDeb commented Oct 26, 2022

place to keep docs todo's
@dkoppstein dkoppstein self-assigned this Oct 26, 2022
@dkoppstein
Copy link

dkoppstein commented Oct 27, 2022 •
edited by WardDeb
Loading

Preliminary thoughts:

  • 1. Need to separate internal docs from external docs - i.e. where does stuff live on the processing server

  • 2. Visualization of the pipeline would be nice

  • 3. config file - what does each field do?

  • 4. what exactly is being done at each step?

  • 5. more description of the CLIs

  • 6. Do we want to expose any functions as a Python API? (cfr. rewrite for manual API calls #43)

more specific doc PRs in progress

@WardDeb WardDeb added the documentation Improvements or additions to documentation label Oct 27, 2022
@WardDeb
Copy link
Member Author

WardDeb commented Oct 28, 2022 •
edited
Loading

  • include samplesheet.csv/demuxsheet.csv explanation

@WardDeb WardDeb mentioned this issue Oct 28, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dkoppstein dkoppstein

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dkoppstein @WardDeb