ProvableHQ / welcome

👋 Welcome to Provable! Zero-Knowledge is Finally Here 🚀
https://provable.com
GNU General Public License v3.0
321 stars 217 forks source link

Add a documentation section for Concepts/Finalize #285

Closed kpandl closed 1 year ago

kpandl commented 1 year ago

Closes https://github.com/AleoHQ/welcome/issues/283

collinc97 commented 1 year ago

Going to wait for @apruden2008 and @craigjson 's reviews before merging to production and closing the issue.

craigjson commented 1 year ago

I see some repeated information in the existing Language/Functions section with this one.

Does it make sense to move the entire Functions section into a new page and document all of them in more detail, we can link to this new section in the existing portion in the Language section.

collinc97 commented 1 year ago

I see some repeated information in the existing Language/Functions section with this one.

Does it make sense to move the entire Functions section into a new page and document all of them in more detail, we can link to this new section in the existing portion in the Language section.

Is the repeated information inconsistent?

How large of a change to the existing language guide would be needed to modify the existing docs @craigjson ?

Can you give @kpandl a checklist of line numbers and paragraphs to address the feedback?

kpandl commented 1 year ago

Thank you for the feedback, @craigjson and @collinc97.

The finalize file contains more detailed information on finalize than the language file. So all of the information of the language file is also in the finalize file, but not necessarily the other way. From my understanding, the repeated information is consistent.

Speaking of line numbers, the following line numbers in the finalize file add information over the language file:

Speaking of line numbers in the language file, information from all lines on finalize (366-413) is also contained in the finalize file.

Going forward, one way to address it would be by making the information in the finalize file more dense, for example by removing the code from lines 377-413 (as the code is also in the finalize section and explained in more depth) and mention in the sentence with the link (line 376) that there is a code example. However, the description of finalize in the language section may then be less consistent with the description of other functions which have an example. I don't think we should remove any information on finalize from lines 368-374. Alternatively, we could include all of the information of the finalize file in the language file, if the standalone finalize file is not necessary to have (I think this is my preferred option right now). @craigjson yes another alternative would be to have a separate functions section if you see room for more detailed descriptions on the other functions.

What do you think? Happy to implement the changes