Skip to content

Commit

Permalink
chore(docs): refactoring guides and some other nits (#6175)
Browse files Browse the repository at this point in the history
This closes the remaining work for restoring some of the devex
regression around noir and bb, and other docs improvements including
homepage removal and redirects set-up.

- [x] Made "Getting Started" E2E with `bbup` and `bb` as examples
(closes #6222 and #6223)
- [x] Removed BB specific documentation
- [x] Updated docusaurus to latest
- [x] Made homepage CTA open the docs in the same tab

---------

Co-authored-by: Savio <[email protected]>
Co-authored-by: Tom French <[email protected]>
  • Loading branch information
3 people authored Oct 19, 2024
1 parent 4d524bf commit 4302e7e
Show file tree
Hide file tree
Showing 23 changed files with 2,463 additions and 525 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:

- name: Build docs
env:
MATOMO_ENV: staging # not really a secret, it will show in the footer anyway
ENV: staging # not really a secret, it will show in the footer anyway
run: yarn workspaces foreach -Rpt --from docs run build

- name: Upload artifact
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ yarn-error.log*

package-lock.json
versions.json
.supermavenignore
3 changes: 0 additions & 3 deletions docs/.markdownlint.json

This file was deleted.

8 changes: 7 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,13 @@ yarn build
### Local Development

```
yarn workspace docs start
yarn workspace docs version
```

This command fetches and compiles the list of documentation versions to build with.

```
yarn workspace docs dev
```

This command starts a local development server and opens up a browser window. Most changes are
Expand Down
5 changes: 0 additions & 5 deletions docs/docs/getting_started/_category_.json

This file was deleted.

6 changes: 0 additions & 6 deletions docs/docs/getting_started/backend/_category_.json

This file was deleted.

31 changes: 0 additions & 31 deletions docs/docs/getting_started/backend/index.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/docs/getting_started/hello_noir/_category_.json

This file was deleted.

157 changes: 0 additions & 157 deletions docs/docs/getting_started/hello_noir/index.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/docs/getting_started/installation/_category_.json

This file was deleted.

46 changes: 0 additions & 46 deletions docs/docs/getting_started/installation/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Alternative Installations
title: Standalone Noir Installation
description: There are different ways to install Nargo, the one-stop shop and command-line tool for developing Noir programs. This guide explains how to specify which version to install when using noirup, and using WSL for windows.
keywords: [
Installation
Expand All @@ -14,11 +14,9 @@ keywords: [
Direnv
Uninstalling Nargo
]
sidebar_position: 1
sidebar_position: 2
---

## Encouraged Installation Method: Noirup

Noirup is the endorsed method for installing Nargo, streamlining the process of fetching binaries or compiling from source. It supports a range of options to cater to your specific needs, from nightly builds and specific versions to compiling from various sources.

### Installing Noirup
Expand All @@ -40,6 +38,7 @@ With `noirup`, you can easily switch between different Nargo versions, including
```

- **Specific Version**: Install a specific version of Nargo.

```sh
noirup --version <version>
```
Expand Down Expand Up @@ -79,6 +78,7 @@ With `noirup`, you can easily switch between different Nargo versions, including
```

- **From Local Source**: Compile and install from a local directory.

```sh
noirup --path ./path/to/local/source
```
Expand All @@ -89,7 +89,7 @@ The default backend for Noir (Barretenberg) doesn't provide Windows binaries at

Step 1: Follow the instructions [here](https://learn.microsoft.com/en-us/windows/wsl/install) to install and run WSL.

step 2: Follow the [Noirup instructions](#encouraged-installation-method-noirup).
step 2: Follow the [Noirup instructions](#installing-noirup).

## Uninstalling Nargo

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description:
file, and how to prove and verify your program.
keywords:
[Nargo, Nargo project, Prover.toml, proof verification, private asset transfer]
sidebar_position: 2
sidebar_position: 1
---

This section breaks down our hello world program from the previous section.
Expand Down Expand Up @@ -46,7 +46,7 @@ license = "MIT"
ecrecover = {tag = "v0.9.0", git = "https://github.com/colinnielsen/ecrecover-noir.git"}
```

Nargo.toml for a [workspace](../../noir/modules_packages_crates/workspaces.md) will look a bit different. For example:
Nargo.toml for a [workspace](../noir/modules_packages_crates/workspaces.md) will look a bit different. For example:

```toml
[workspace]
Expand All @@ -66,11 +66,11 @@ The package section defines a number of fields including:
- `entry` (optional) - a relative filepath to use as the entry point into your package (overrides the default of `src/lib.nr` or `src/main.nr`)
- `backend` (optional)
- `license` (optional)
- `expression_width` (optional) - Sets the default backend expression width. This field will override the default backend expression width specified by the Noir compiler (currently set to width 4).
- `expression_width` (optional) - Sets the default backend expression width. This field will override the default backend expression width specified by the Noir compiler (currently set to width 4).

#### Dependencies section

This is where you will specify any dependencies for your project. See the [Dependencies page](../../noir/modules_packages_crates/dependencies.md) for more info.
This is where you will specify any dependencies for your project. See the [Dependencies page](../noir/modules_packages_crates/dependencies.md) for more info.

`./proofs/` and `./contract/` directories will not be immediately visible until you create a proof or
verifier contract respectively.
Expand Down
Loading

0 comments on commit 4302e7e

Please sign in to comment.