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

Docs snippet-ification #4174

Open
5 of 13 tasks
TomAFrench opened this issue Jan 25, 2024 · 1 comment
Open
5 of 13 tasks

Docs snippet-ification #4174

TomAFrench opened this issue Jan 25, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@TomAFrench
Copy link
Member

TomAFrench commented Jan 25, 2024

After #4164, we can now include code snippets from across the monorepo into the Noir docs. We've got a good amount of code-blocks in the docs which were copied across and so can be broken #4172. We should push any code blocks out of the docs and into tests/examples for which correctness is enforced in CI.

Getting Started

Concepts

  1. bug documentation

stdlib

  1. documentation enhancement
  2. guipublic
  3. documentation
    guipublic

Modules, Packages and Crates

How To Guides

@TomAFrench TomAFrench added the documentation Improvements or additions to documentation label Jan 25, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Jan 25, 2024
@signorecello
Copy link
Contributor

@jzaki this could be a good first issue in Noir docs if you happen to have the availability

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
Status: 📋 Backlog
Development

No branches or pull requests

2 participants