write a paper for the JOSS journal
This MR adds the JOSS paper of Komodo.
🟢 pre-review: github.com:openjournals/joss-reviews#9577
🟢 review: github.com:openjournals/joss-reviews#9791
🟢 tickets: JOSS label (still opened)
Note
template from https://joss.readthedocs.io/en/latest/example_paper.html.
Tip
the PDF is generated automatically on the mirror: https://github.com/dragoon-rs/komodo/actions/workflows/draft-pdf.yml
TODO
- complete "Merkle Tree and Fiat-Shamir" paragraph done as part of #25 (closed) in 5b99b43f
- write "general data flow" section done as part of #25 (closed) in 78b13132
- write "statement of need" section done in !228 (merged)
- update "outdated" parts done as part of #25 (closed) in 51a68383 and 4bbe608e
- #24 (closed)
- #25 (closed)
- #26 (closed)
- #27 (closed)
-
mention the multiple available versions of Komodo ? (namely1.1.0,1.0.2,1.0.1,1.0.0andmain) - !228 (merged)
- accepted by https://github.com/openjournals/joss-reviews/issues/9577 (see https://github.com/openjournals/joss-reviews/issues/9791#issuecomment-4313256332)
-
sync the README intro with the intro of
paper.md(see https://github.com/openjournals/joss-reviews/issues/9791#issuecomment-4313027351)
final submission
verify the following items
- the submission instructions
-
there is a
paper.mdfile in the root of the project - the template used is from here
- the correct GitHub action is used
- the required sections have been included
review changelog
- 0f92da72 update bib
- f56dc757 fix references in paper.md
- a3db0002 update bib
- f66b494f add JOSS intro (adapted) to the README
- ddf420e5 update bib
- 07b161c9 remove some sections (2561w -> 1596w)
- 2a5f9826 simplify (1596w -> 1533w)
- 74497b24 move figure comments together
- 5ae7bd35 remove "komodo" section (1533w -> 972w)
- a9448503 add back protocols and arkworks (972w -> 1029w)
- 9aed0943 homogenize use of "Komodo" and citations (1029w -> 1021w)
- 5b6e1843 remove duplicate formulations (1021w -> 999w)
- 4f7e2ad3 update README
- fa3bbabc fix documentation with/without KaTeX
- fa3bbabcb..16e8fe1
- b1bf0cdc bump Komodo to 1.2.0
Edited by STEVAN Antoine