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

Create examples/README.md #7259

Open
Savio-Sou opened this issue Feb 3, 2025 · 0 comments
Open

Create examples/README.md #7259

Savio-Sou opened this issue Feb 3, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Feb 3, 2025

Problem

We have:

which seems to serve the same goal of hosting demonstrative Noir programs, but unclear why we have both.

Happy Case

Create a README in https://github.com/noir-lang/noir/tree/master/examples, documenting:

  • Intention of / how to use the folder
  • How is the folder maintained (e.g. tested on every PR?)
  • Process / criteria for adding and removing examples from the folder

Workaround

Yes

Workaround Description

If they indeed serve the same goal, merge:

Project Impact

Nice-to-have

Would you like to submit a PR for this Issue?

No

@Savio-Sou Savio-Sou added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 3, 2025
@Savio-Sou Savio-Sou added this to Noir Feb 3, 2025
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Feb 3, 2025
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
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant