Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: recursion howto explainers #3792

Merged
merged 23 commits into from
Dec 15, 2023

Conversation

signorecello
Copy link
Contributor

@signorecello signorecello commented Dec 13, 2023

Description

This PR also moves things around to accomodate one new how-to and its correspondent explainer

Problem*

An explainer and a guide on recursion was long overdue, but very much needed.

Summary*

It may seem like a lot of files but most of them are just things moving around:

  • Created a new top-level category "Noir" to avoid mixing syntax stuff with high-level explanations. That's most of the file moves
  • Added a divider on the sidebar
  • In the new "explanation" category, I wrote an explainer. This is one of the two files that needs to be reviewed
  • In the how to category, I wrote a guide. This also needs to be reviewed
  • I found out the links to @site were valid... But they route to the assets, thus rendering the page in markdown format 😱 The docusaurus documentation is not entirely clear about that, and I clearly missed the tiny reference to that fact in the advanced pages.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 13, 2023
Copy link
Contributor

github-actions bot commented Dec 13, 2023

Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not following some of the examples you've given. Could you explain a bit more as it's not clear to me why we need to do so many proofs.

Also, I think the recursion interface is going to change soon so technical docs may be out of date soon.

docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
@TomAFrench TomAFrench changed the title feat: recursion howto explainers chore: recursion howto explainers Dec 13, 2023
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/how_to/how-to-recursion.md Outdated Show resolved Hide resolved
Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technical stuff looks ok now. I think that we're not being totally clear about why you would use different architectures of recursive proofs however.

docs/docs/how_to/how-to-recursion.md Show resolved Hide resolved
docs/docs/how_to/how-to-recursion.md Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
@signorecello
Copy link
Contributor Author

signorecello commented Dec 14, 2023

Thanks @TomAFrench just made some changes as suggested. Lmk if there's anything else, otherwise let's merge please because there's a bug in master so this needs to go in 0.21.0

docs/docs/explainers/explainer-recursion.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-recursion.md Show resolved Hide resolved
docs/docs/how_to/how-to-recursion.md Show resolved Hide resolved
Copy link
Contributor

@critesjosh critesjosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the caveats at the top of the How To Guide. That page can still use some improvement, but I think it's ok to ship now and we can iterate on it based on feedback we get. 🚀

@signorecello signorecello added this pull request to the merge queue Dec 15, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 15, 2023
@signorecello signorecello added this pull request to the merge queue Dec 15, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 15, 2023
@signorecello signorecello added this pull request to the merge queue Dec 15, 2023
Merged via the queue into master with commit eaf13bc Dec 15, 2023
34 checks passed
@signorecello signorecello deleted the zpedro/recursion_howto_explainers branch December 15, 2023 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants