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

Swap "Examples" and "NoirJS/Guides" sections in Docs with a link to noir-examples #3551

Closed
Savio-Sou opened this issue Nov 23, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Nov 23, 2023

Problem

In the Examples section, we currently have one very outdated Merkle Proof Membership example.

Meanwhile in the NoirJS/Guides section, we also have one easily-outdatable End-to-end example.

Writing, maintaining and documenting examples at two different places (in noir-examples and in Noir Docs) is error-prone, labor-consuming and perhaps unnecessary.

Happy Case

  1. Remove the Examples and NoirJS/Guides sections
  2. Add a link to noir-examples in the sidebar

Alternatives Considered

  • Leave everything as is, or
  • Just remove the sections, but not add the link

Additional Context

Personal recommendation: external links in general should live as bottommost items on the sidebar to minimize distractions.

Would you like to submit a PR for this Issue?

No

Support Needs

No response

@Savio-Sou Savio-Sou added enhancement New feature or request documentation Improvements or additions to documentation labels Nov 23, 2023
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Nov 23, 2023
@Savio-Sou Savio-Sou added the good first issue Good for newcomers label Nov 29, 2023
@Savio-Sou Savio-Sou changed the title Swap "Examples" section in Docs with a link to noir-examples Swap "Examples" and "NoirJS/Guides" sections in Docs with a link to noir-examples Dec 4, 2023
@kevaundray
Copy link
Contributor

@Savio-Sou / @signorecello what is the status of this issue?

@Savio-Sou
Copy link
Collaborator Author

Savio-Sou commented Jan 16, 2024

@signorecello clarified that noir-examples are not aimed to be fully up-to-date at all times:

#3711 (comment):

It is not meant to be up-to-date, unless breaking changes show up. By trusting the community to flag when some change goes undetected by devrel (which inevitably happens), we can keep them fairly up-to-date with the latest syntax without depleting all of our time.
So the happy case suggested in this issue does not necessarily address the problem.

As of #3711, the examples were moved into "How To Guides" and "Tutorials" sections that are now clearly separated from language sections in the sidebar. Reader confusions regarding outdated guides in docs could have been lowered since.

Given such, closing this as not planned for now.

If outdated guides in our docs as is are later found confusing / unhelpful still, we can consider proper approaches to update (e.g. binding examples to CI) or remove them.

@Savio-Sou Savio-Sou closed this as not planned Won't fix, can't repro, duplicate, stale Jan 16, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Jan 16, 2024
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 enhancement New feature or request good first issue Good for newcomers
Projects
Archived in project
Development

No branches or pull requests

2 participants