Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
himself65 committed Feb 4, 2024
1 parent 6fe55d6 commit 4562d3a
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,33 @@ pnpm start
That should start a webserver which will serve the docs on https://localhost:3000

Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again.

## Publishing

To publish a new version of the library, run

```shell
pnpm release # will run the build command, run the tests, and create a new version commit
pnpm new-llamaindex # only release the llamaindex package
pnpm new-create-llama # only release the create-llama package
```

### Release `llamaindex`

```shell
cd packages/core/dist
pnpm publish
```

### Release `create-llama`

```shell
cd packages/create-llama
pnpm publish
```

### Push new changes to the repository

```shell
git push
```

0 comments on commit 4562d3a

Please sign in to comment.