Draft: Resolve "Draft a template and requirement checklist for how to write and review a defense system"
Closed
requested to merge 145-draft-a-template-and-requirement-checklist-for-how-to-write-and-review-a-defense-system into dev
Proposition of
- a template to create wiki pages
- a guide to review wiki pages
Merge request reports
Activity
Filter activity
changed milestone to %fixed before hackaton
added DefenseSystem documentation enhancement labels
assigned to @jcury
requested review from @ftesson
In REVIEWER_GUIDES.md : In the frontmatter, need to add the contributors field:
title: tableColumns: article: doi: abstract: Sensor: Activator: Effector: PFAM: contributors: - Author
In TEMPLATE.md : For experimental validatio: Using mermaid for the representation I don't know exactly how to explain. Basically everything is link by arrow:
A --> B where A and B are the node ID For each experimtal validation you have to add:
graph LR; Source --> Origin Origin --> Expressed Expressed --> Phage subgraph Title1[Reference] Source end subgraph Title2[System origin] Origin end subgraph Title3[Expression species] Expressed end subgraph Title4[Phage infected] Phage end style Title1 fill:none,stroke:none,stroke-width:none style Title2 fill:none,stroke:none,stroke-width:none style Title3 fill:none,stroke:none,stroke-width:none style Title4 fill:none,stroke:none,stroke-width:none
Example from Tiamat:
graph LR; Millman_2022[<a href='https://doi.org/10.1016/j.chom.2022.09.017'>Millman et al., 2022</a>] --> Origin_0 Origin_0[Bacillus cereus <a href='https://img.jgi.doe.gov/cgi-bin/m/main.cgi?section=GeneDetail&page=geneDetail&gene_oid=2641244160'>2641244160</a>] --> Expressed_0[Escherichia coli] Expressed_0[Escherichia coli] ----> T6 & T5 subgraph Title1[Reference] Millman_2022 end subgraph Title2[System origin] Origin_0 end subgraph Title3[Expression species] Expressed_0 end subgraph Title4[Phage infected] T6 T5 end style Title1 fill:none,stroke:none,stroke-width:none style Title2 fill:none,stroke:none,stroke-width:none style Title3 fill:none,stroke:none,stroke-width:none style Title4 fill:none,stroke:none,stroke-width:none
Edited by ftesson
Please register or sign in to reply