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

chore(docs): Minor fixes on local documentation development workflows #7684

Merged
merged 4 commits into from
Mar 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 26 additions & 11 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,28 @@ Check out the contributing guide [here](../CONTRIBUTING.md).

### Installation

This project requires recent versions of rust and cargo to be installed.
This project requires recent versions of Rust and Cargo to be installed.
Any build errors should indicate dependencies that need installing, and at what version.

On the root folder of the repository, run:
From the _noir_ root directory, run:

```
```sh
yarn
yarn build
```

### Local Development

```
yarn workspace docs version
```
From the _noir_ root directory:

This command fetches and compiles the list of documentation versions to build with.
1. Fetch and generate the list of recent stable documentation versions to build:

```sh
yarn workspace docs version::stables
```

2. Start a development server serving docs preview:

```sh
yarn workspace docs dev
```

Expand All @@ -42,13 +45,25 @@ reflected live without having to restart the server.

### Build

From the _noir_ root directory:

1. Fetch and generate the list of recent stable documentation versions to build:

```sh
yarn workspace docs version::stables
```

2. Build the docs:

```sh
yarn workspace docs build
```

This command generates static content into the `build` directory and can be served using any static
contents hosting service. You can see a preview by running:
This command generates static content into the _build_ directory and can be served using any static
contents hosting service.

```
3. Verify build by serve a preview of the docs locally:

```sh
yarn workspace docs serve
```
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"preprocess": "yarn workspace @noir-lang/acvm_js build && ./scripts/codegen_nargo_reference.sh && yarn node ./scripts/preprocess/index.js",
"dev": "yarn preprocess && ENV=dev docusaurus start",
"build": "yarn preprocess && docusaurus build",
"clean": "rm -rf ./processed-docs ./processed-docs ./build",
"clean": "rm -rf ./processed-docs ./processed-docs-cache ./build",
"version::stables": "ts-node ./scripts/setStable.ts",
"serve": "serve build",
"swizzle": "docusaurus swizzle",
Expand Down
Loading