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.

Sign up for GitHub

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

Jump to bottom

Document noir_wasm #4137

Closed
Savio-Sou opened this issue Jan 23, 2024 · 0 comments · Fixed by #4213
Closed

Document noir_wasm #4137

Savio-Sou opened this issue Jan 23, 2024 · 0 comments · Fixed by #4213
Assignees
@Thunkar
Labels
documentation Improvements or additions to documentation js Noir's JavaScript packages

Comments

@Savio-Sou
Copy link
Collaborator

noir_wasm is a JavaScript package for compiling Noir programs, available on NPM.

Prior to announcing and publicly releasing the package, we should first document how it can be used.

References:
@Savio-Sou Savio-Sou added js Noir's JavaScript packages documentation Improvements or additions to documentation labels Jan 23, 2024
@Savio-Sou Savio-Sou added this to Noir Jan 23, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir Jan 23, 2024
@Thunkar Thunkar self-assigned this Jan 31, 2024
@Thunkar Thunkar mentioned this issue Jan 31, 2024
Merged
5 tasks
@Thunkar Thunkar moved this from 📋 Backlog to 🏗 In progress in Noir Feb 1, 2024
github-merge-queue bot pushed a commit that referenced this issue Feb 8, 2024
@Thunkar
chore: document noir_wasm (#4213)
ba25a97 
## Problem

Resolves #4137

## Summary

Added using typedoc, better comments and improved readme.

Check one:
- [ ] No documentation needed.
- [x] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Noir Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Thunkar Thunkar

Labels
documentation Improvements or additions to documentation js Noir's JavaScript packages
Projects
Noir
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: document noir_wasm noir-lang/noir
2 participants
@Thunkar @Savio-Sou