Skip to content

Conversation

@jrchatruc
Copy link
Collaborator

@jrchatruc jrchatruc commented Mar 20, 2023

Description

This PR adds documentation for the Stark prover on the mathematical side. A subsequent PR will add documentation on the actual implementation.

A /docs directory was added to the root of the repo, using an mdbook where we should add all our documentation. The book is deployed to github pages using a workflow. You can check out the site here.

A docs makefile target was also added to serve the documentation locally.

Type of change

  • Documentation

@codecov-commenter
Copy link

codecov-commenter commented Mar 20, 2023

Codecov Report

Merging #194 (1871393) into main (6ee9655) will decrease coverage by 3.41%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #194      +/-   ##
==========================================
- Coverage   95.58%   92.17%   -3.41%     
==========================================
  Files          62       66       +4     
  Lines        6837     7208     +371     
==========================================
+ Hits         6535     6644     +109     
- Misses        302      564     +262     

see 16 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@jrchatruc jrchatruc force-pushed the stark-prover-documentation branch from cb1e341 to 8632ab0 Compare March 21, 2023 20:15
@jrchatruc jrchatruc force-pushed the stark-prover-documentation branch from ec91b9a to c5622bd Compare March 21, 2023 21:15
@jrchatruc jrchatruc marked this pull request as ready for review March 27, 2023 02:55
@jrchatruc jrchatruc requested review from a team, ajgara and schouhy as code owners March 27, 2023 02:55
@jrchatruc
Copy link
Collaborator Author

Closed as it was merged as part of #214

@jrchatruc jrchatruc closed this Mar 28, 2023
@diegokingston diegokingston deleted the stark-prover-documentation branch October 1, 2024 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants