Skip to content

Commit

Permalink
docs: added changesets for core
Browse files Browse the repository at this point in the history
  • Loading branch information
marcusschiesser committed Jan 2, 2024
1 parent d52eb9d commit c835f78
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .changeset/loud-files-do.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"llamaindex": patch
---

Use compromise as sentence tokenizer
5 changes: 5 additions & 0 deletions .changeset/moody-berries-reflect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"llamaindex": patch
---

Removed pdf-parse, and directly use latest pdf.js
5 changes: 5 additions & 0 deletions .changeset/small-paws-sneeze.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"llamaindex": patch
---

Added pinecone vector DB
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Right now there are two packages of importance:

packages/core which is the main NPM library llamaindex

apps/simple is where the demo code lives
examples is where the demo code lives

### Turborepo docs

Expand Down Expand Up @@ -47,7 +47,7 @@ We use Jest https://jestjs.io/ to write our test cases. Jest comes with a bunch

### Demo applications

There is an existing ["simple"](/apps/simple/README.md) demos folder with mainly NodeJS scripts. Feel free to add additional demos to that folder. If you would like to try out your changes in the core package with a new demo, you need to run the build command in the README.
There is an existing ["example"](/examples/README.md) demos folder with mainly NodeJS scripts. Feel free to add additional demos to that folder. If you would like to try out your changes in the core package with a new demo, you need to run the build command in the README.

You can create new demo applications in the apps folder. Just run pnpm init in the folder after you create it to create its own package.json

Expand All @@ -56,7 +56,7 @@ You can create new demo applications in the apps folder. Just run pnpm init in t
To install packages for a specific package or demo application, run

```
pnpm add [NPM Package] --filter [package or application i.e. core or simple]
pnpm add [NPM Package] --filter [package or application i.e. core or docs]
```

To install packages for every package or application run
Expand Down

0 comments on commit c835f78

Please sign in to comment.