search

ZK-Garage / plonk

A pure Rust PLONK implementation using arkworks as a backend.
https://discord.gg/XWJdhVf37F
Mozilla Public License 2.0
295 stars 76 forks source link

Update and Extend Documentation #91

Closed markulf closed 2 years ago

markulf commented 2 years ago

Starting with broken links. But any other kind of documentation is also welcome. Might by its very nature, documentation is never finished, be broken up into multiple pull requests.

CPerezz commented 2 years ago

I highly reccomend you to look at https://keepachangelog.com/en/1.0.0/ in order to add a CHANGELOG.

Anyway, since we will start on 0.1, we will just start mantaining it after that. Otherways there's A LOT of PR's to take into account.

markulf commented 2 years ago

I highly reccomend you to look at https://keepachangelog.com/en/1.0.0/ in order to add a CHANGELOG.

Anyway, since we will start on 0.1, we will just start mantaining it after that. Otherways there's A LOT of PR's to take into account.

Makes sense, probably still better to have a stub there than a broken link. Added a comment that we start this process from version 0.1.

markulf commented 2 years ago

Closing this. Too many small building sites for one pull request.

CPerezz commented 2 years ago

@bhgomes @LukePearson1 This PR started to make the intra-doc links fail.

Why was it merged?

bhgomes commented 2 years ago

@bhgomes @LukePearson1 This PR started to make the intra-doc links fail.

Why was it merged?

We don't know how the intra-doc links are broken since this PR doesn't seem to change anything related to that.