ethereum / ethereum/cryptography-specs

Find a good way to document proofs

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Lean
Stars
15
Forks
2
Avg merge
18h 11m
Merged PRs (30d)
1

Description

As we add more and more proofs about the spec to the repository, we should think about a good way to document what we have proven.
This does not mean documenting every single lemma, but the headline theorems. E.g., in a latex companion. Or just a list or issue would already be a good start.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by surveying the repository's existing proofs and identifying the headline theorems, rather than individual lemmas. Done means choosing and documenting a maintainable format, such as a LaTeX companion or a concise theorem list, with the proven results represented clearly.

Written by the indexing model from the issue text.

Assessment

Domain
cryptography, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.