Documentation for gwas-sumstat-tools

[jiyue1214]

We need to create an online documentation/ tutorial about how to use gwas-sumstat-tools, so that both internal and external users can read and use gwas-sumstat-tools using CLI or UI. When our formatted UI/webassembly mainly aim external users, this documentation is essential to guide how to edit the configure file to reformat their data. The documentation template is here: https://jiyue1214.github.io/gwas-sumstats-tools-Documentation/#/

• [x] Create an template for gwas-sumstat-tools documentation (https://jiyue1214.github.io/gwas-sumstats-tools-Documentation/#/).
• [ ] Editing the content for format CLI users
• [ ] Editing the content for format UI users
• [ ] Editing the content for read, validate and generate meta_data

When a user visits the documentation website, the user should find clear instructions on how to use the tools, including formatting and editing the configure file

[eks-ebi]

@eks-ebi to think about where to display documentation on GWAS Catalog website

[jiyue1214]

Here is the initial draft, and I would appreciate any suggestions you may have to improve it.

[eks-ebi]

@jiyue1214 The documentation looks really nice and very helpful! I've started writing up some feedback in this document - I haven't gone through everything yet, but I'll try to keep updating it over the next few days

[jiyue1214]

I have improved the documentation according to Elliot's suggestion.

[jiyue1214]

I have migrated the documentation repo to EBISPOT: https://ebispot.github.io/gwas-sumstats-tools-documentation/#/

[eks-ebi]

@eks-ebi add link to this documentation in the main GWAS Catalog submission documentation

[jiyue1214]

This ticket can be closed.