Skip to content

Commit

Permalink
docs: updated readme with new deployment details
Browse files Browse the repository at this point in the history
  • Loading branch information
deowk committed May 15, 2024
1 parent 80eb4b3 commit 1b44230
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,9 @@ This command generates static content into the `build` directory and can be serv

### Deployment

Using SSH:
When submitting a PR against main the `test-deploy` workflow will run, this will ensure that the documentation builds successfully without deploying anything to github pages

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
When PRs are merged into main the `deploy` workflow will run, this will build and deploy documentation to github pages at the given custom url aiblock.dev

### Docker

Expand Down

0 comments on commit 1b44230

Please sign in to comment.