simularium / simularium-website

Front end website for the Simularium project, includes the Simularium viewer
https://simularium.allencell.org
Apache License 2.0
6 stars 3 forks source link

add more detailed documentation #494

Closed meganrm closed 3 months ago

meganrm commented 3 months ago

Time estimate or Size

small

Problem

the docs didn't include info on updating the viewer

Solution

Add the info to the docs

Type of change

Please delete options that are not relevant.

github-actions[bot] commented 3 months ago

Coverage report

St.:grey_question:
Category Percentage Covered / Total
🟑 Statements
73.27% (-11.39% πŸ”»)
603/823
🟑 Branches
68.38% (-5.65% πŸ”»)
80/117
πŸ”΄ Functions
40.31% (-18.03% πŸ”»)
79/196
🟑 Lines
71.73% (-12.93% πŸ”»)
538/750
Show new covered files 🐣
|
St.:grey_question:
| File | Statements | Branches | Functions | Lines | | :----------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------ | :--------- | :------- | :-------- | :----- | | 🟒 | src/state/index.ts | 100% | 100% | 66.67% | 100% | | πŸ”΄ |
`...` / reducer.ts
| 33.33% | 100% | 0% | 33.33% | | 🟒 |
`...` / constants.ts
| 100% | 100% | 100% | 100% | | πŸ”΄ |
`...` / reducer.ts
| 21.74% | 100% | 0% | 21.74% | | 🟒 |
`...` / constants.ts
| 100% | 100% | 100% | 100% | | πŸ”΄ |
`...` / reducer.ts
| 23.81% | 0% | 0% | 23.81% | | 🟒 |
`...` / constants.ts
| 100% | 100% | 100% | 100% | | 🟑 |
`...` / reducer.ts
| 71.43% | 100% | 0% | 71.43% | | 🟒 |
`...` / constants.ts
| 100% | 100% | 100% | 100% | | 🟒 |
`...` / index.ts
| 100% | 100% | 100% | 100% | | πŸ”΄ |
`...` / actions.ts
| 52.17% | 100% | 0% | 52.17% | | πŸ”΄ |
`...` / logics.ts
| 21.37% | 0% | 0% | 21.37% | | πŸ”΄ |
`...` / actions.ts
| 52.63% | 100% | 0% | 52.63% | | 🟑 |
`...` / actions.ts
| 66.67% | 100% | 0% | 66.67% | | 🟒 |
`...` / index.ts
| 100% | 100% | 100% | 100% | | πŸ”΄ |
`...` / basic.ts
| 66.67% | 100% | 0% | 50% | | πŸ”΄ |
`...` / actions.ts
| 53.33% | 100% | 0% | 53.33% | | 🟒 |
`...` / index.ts
| 100% | 100% | 100% | 100% | | πŸ”΄ |
`...` / logics.ts
| 27.27% | 0% | 0% | 27.27% | | 🟒 |
`...` / index.ts
| 100% | 100% | 100% | 100% | | πŸ”΄ |
`...` / logics.ts
| 45.45% | 0% | 0% | 45.45% | | 🟒 |
`...` / index.ts
| 100% | 100% | 100% | 100% | | 🟒 |
`...` / basic.ts
| 66.67% | 100% | 0% | 85.71% | | 🟒 |
`...` / index.ts
| 100% | 100% | 100% | 100% | | 🟒 |
`...` / logics.ts
| 100% | 100% | 100% | 100% | | πŸ”΄ |
`...` / configure-store.ts
| 56.25% | 0% | 0% | 56.25% | | 🟒 |
`...` / selectors.ts
| 100% | 100% | 100% | 100% |

Test suite run success

99 tests passing in 7 suites.

Report generated by πŸ§ͺjest coverage report action from 21ce91031947f643b043e14397eb73082a58d94b