Skip to content

Commit

Permalink
chore(docs): autogeneration of NoirJS docs (#3349)
Browse files Browse the repository at this point in the history
  • Loading branch information
signorecello authored Nov 6, 2023
1 parent 874b2bf commit fab9970
Show file tree
Hide file tree
Showing 18 changed files with 379 additions and 440 deletions.
30 changes: 28 additions & 2 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,37 @@ jobs:
with:
node-version: '18'

- name: Install wasm-bindgen-cli
uses: taiki-e/install-action@v2
with:
tool: [email protected]

- name: Install wasm-opt
run: |
npm i wasm-opt -g
- name: Install dependencies
run: yarn


- name: Build acvm_js
run: yarn workspace @noir-lang/acvm_js build

- name: Build noirc_abi
run: yarn workspace @noir-lang/noirc_abi build

- name: Build noir_js_types
run: yarn workspace @noir-lang/types build

- name: Build barretenberg wrapper
run: yarn workspace @noir-lang/backend_barretenberg build

- name: Run noir_js
run: |
yarn workspace @noir-lang/noir_js build
- name: Build docs
run: yarn workspace docs build
run:
yarn workspace docs build

- name: Remove pre-releases
working-directory: docs
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
# Generated files
.docusaurus
.cache-loader
/docs/noir_js/reference/

# Misc
.DS_Store
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/noir_js/noir_js.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ To install its JavaScript library, run this in your project:
npm i @noir-lang/backend_barretenberg
```

For more details on how to instantiate and use the libraries, refer to the [Full Noir App Guide](./getting_started/01_tiny_noir_app.md) and [Reference](./reference/01_noirjs.md) sections.
For more details on how to instantiate and use the libraries, refer to the [Full Noir App Guide](./getting_started/01_tiny_noir_app.md) and [Reference](./reference/noir_js/classes/Noir.md) sections.
147 changes: 0 additions & 147 deletions docs/docs/noir_js/reference/01_noirjs.md

This file was deleted.

Loading

0 comments on commit fab9970

Please sign in to comment.