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

Plan out the documentation #36

Open
1 of 3 tasks
abhi18av opened this issue Nov 16, 2021 · 5 comments · Fixed by #76 or #141
Open
1 of 3 tasks

Plan out the documentation #36

abhi18av opened this issue Nov 16, 2021 · 5 comments · Fixed by #76 or #141
Assignees
@abhi18av @Mxrcon
Labels
documentation Improvements or additions to documentation

Comments

@abhi18av
Copy link
Member

abhi18av commented Nov 16, 2021 •
edited
Loading

  • Choose a doc framework (public website)
  • Make no assumptions on the background of user
  • Provide a script for generating the initial samplesheet
@abhi18av
Copy link
Member Author

abhi18av commented Dec 8, 2021

https://docusaurus.io/docs

@abhi18av abhi18av linked a pull request Feb 11, 2022 that will close this issue
Initiate work on the website #76
Merged
@abhi18av abhi18av self-assigned this Feb 11, 2022
@abhi18av abhi18av reopened this Feb 11, 2022
@abhi18av abhi18av added the documentation Improvements or additions to documentation label Feb 17, 2022
@abhi18av abhi18av added this to the v0.9.8 milestone Mar 15, 2022
@abhi18av
Copy link
Member Author

abhi18av commented May 17, 2022 •
edited
Loading

Building upon the experience of TDRC-Zambia training, I think it'd be best if the website has the following sections

  1. Quickstart (with instructions for setting up Conda and Docker)
  2. Parameter docs
  3. Explanation of results

@adippenaar @adippenaar01 , may I request your help on this one please?

@abhi18av
Copy link
Member Author

We don't recommend changing the reference (WARNING)!

@abhi18av abhi18av modified the milestones: v0.9.8, v1.0.0 Sep 27, 2022
@abhi18av abhi18av linked a pull request Nov 1, 2022 that will close this issue
[DRAFT] Magma name refactor #132
Closed
@abhi18av abhi18av linked a pull request Jan 15, 2023 that will close this issue
Rename pipeline to magma and update documentation #141
Merged
@abhi18av abhi18av reopened this Jul 31, 2024
@abhi18av
Copy link
Member Author

Reopening this as we need to implement the website.

@abhi18av abhi18av pinned this issue Jul 31, 2024
@abhi18av abhi18av removed this from the v1.0.0 milestone Jul 31, 2024
@abhi18av
Copy link
Member Author

I've setup the docs to be published here https://torch-consortium.github.io/MAGMA/usage.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@abhi18av abhi18av

@Mxrcon Mxrcon

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
2 participants
@abhi18av @Mxrcon