Skip to content

Commit

Permalink
Docs: Update README with note about deploy preview link
Browse files Browse the repository at this point in the history
Add a note about appending `docs/` to Netlify's generated deploy preview link so you can preview your changes.
  • Loading branch information
aimeeu authored Feb 23, 2024
1 parent 837880d commit eb0be31
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
That means, for installing and developing this docusaurus documentation, you will need to have node@16 or higher.

## Local development

Execute these commands from the `/docs/` directory.

### Installation

```
$ yarn
```

### Local Development
### Local server

```
$ yarn start
Expand All @@ -26,16 +29,21 @@ $ yarn build

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Pull request deploy preview

Netlify generates a deploy preview URL. To see your changes, append `docs/` to the generated URL.

## Creating New Versions
## Creating new versions

### 1. Generate command docs

### 1. Generate Command Docs
```bash
cd ../ # main project directory
go run -mod=vendor ./hack/gen-docs.go
```

### 2. Create Version
### 2. Create version

```bash
yarn run docusaurus docs:version 0.1
```

0 comments on commit eb0be31

Please sign in to comment.