Generate report for the encodings
The goal of this task is to automatically generate a report for the proofs of encodings on the website. Regexps to list the definitions/proofs of encodings:
To generate a report, generate a markdown file in a folder reports
in src/Proto_alpha/
. Then this markdown file will be rendered by the CI on the website.
To generate this report, write a script in Ruby or Python. This script should be launched by the CI just before the command ruby build-doc.rb
. The report can be the list of files with the number of encoding definitions/proofs, some green/red emoji for completion or not, and a global percent counter to know the global progress.