###### tags: `igem` `software` `wiki`

[TOC]

# iGEM 2021 - Software - Wiki

## About

### Scope

The scope of this note is wiki *infra* work.
For wiki *content* work, see:
https://bit.ly/friendzymes_igem_wiki-tasks

### TODOs

:::info
- [x] Add the wiki tasks spreadsheet contents
- [x] Add wiki frontend repo info
- [x] add notes from chat thread
:::

## v0.1

Wiki v0.1 is almiro work up through 2021-10-06.
https://github.com/Open-Science-Global/Friendzymes_wiki_figma/releases

SW Deliverable 1-4 (Wiki)'s next release should include:
- https://nbconvert.readthedocs.io/
- https://github.com/Lattice-Automation/seqviz
- d3 if we're going to have additional interactives

## v0.2

:::info

Wiki v0.2 is the next release,
- integrating other dependencies (see above)
- normalizing the existing codebase (names, linting, etc.)
- adding github pages

:::

- [x] github pages active
- vanilla html5 / no static engine
- https://open-science-global.github.io/friendzymes-wiki/
- [x] basic first pass at cleanup
- normalization
- typo fixes
- special char handling
- [x] integration of dependencies/libs
- split 1st and 3rd party code
- src/ contains 1st party code
- lib/ contains 3rd party code
- added libs
- lib/d3.min.js
- lib/jquery.min.js
- lib/seqviz.min.js
- deferred fontawesome pending license q
- deferred nbconvert (cli tool a la pandoc)

## v0.3

:::info
**Wiki v0.3 will be a bugfix and usability release**
:::

### Known issues stashed for v0.3

- [ ] pagination: add controls.
- mouse and arrowkey events should trigger next/prev.
- slides should 'wrap' around from last to first.
- home/landing page should be reachable.
- [x] viewport recalculation: broken.
- slide dimensions are way off when window changes size.
- needs fix.
- [ ] css: remove dead styles
- [ ] type: needs many fixes
- font-family alternates, fallbacks, and weights
- kerning & leading & scale control

### Other

- [x] actual code review?
- Will wait to see what @isaacguerreiro#6447 thinks
- should the wiki's source be 'nice' for judging?
- **Verdict: no**
- [x] fontawesome: use license?
- I have an extra fontawesome license
- it's collecting dust
- good thru 2022
- almiro, we use it yes?
- **Verdict: yes**

### Addenda via chat

Jeremy Cahill — 2021-10-08

noting before i forget
- goal: make responsive easier with a framework.
- framework du jour = tailwind css
- test phone layout
- side menu open on load
- MVP: 1D scroll + subpage nav via side menu
- wiki team's preference if possible = 2D scroll

---

:::warning

V0.3 is the tipping point after which it should be safe to start populating the wireframe with production content, so the focus needs to stay on the mechanics.

:::

---

## v0.4

### Cosmetic Tweaks

- [ ] favicon
- [ ] sharper / higher-fidelity copy of logo
- [ ] alternatives to current DNA ligase background element?
- Our current element is the "DNA Ligases" icon here:
- https://openbioeconomy.org/projects/open-enzyme-collections/
- David Goodsell produced an attractive T6 ligase
- https://pdb101.rcsb.org/motm/55
- Could also ask Sana to look at enhancing our current image

### GitHub Garnish

:::info

**aka: Open Source Project Presence**

- the team wiki is as good a place as any for this
- the wiki will be high activity for a while
- will also be low barrier to entry vs. core repos
- thus more activity can nucleate around the wiki

:::

- [ ] make the README and github garnish exist
- add nontrivial text to README
- add badges, social links, glitter
- add social preview
- 
- turn gh sponsors on