Contributing

We welcome contributions to this project.

Releasing a snapshot version

To release a snapshot version to test changes, run the following command:

npx run snapshot

Releasing a new version

pnpm changeset
pnpm version-packages
grlz 'new version'
pnpm release
pnpm update-examples

Testing locally

To test the changes locally, you can run the following command:

Navigate to an example's folder like the Next.js one in examples/nextjs.
Change the package.json to point to the local package for baseai and @baseai/core packages.

{
  "dependencies": {
    "@baseai/core": "workspace:*"
  },
  "devDependencies": {
      "baseai": "workspace:*"
  }
}

Now run in the root:

pnpm clean-all && pnpm install

Then run the development server:

pnpm dev

Run the BaseAI local server from the example's folder without using the @latest flag:

# In examples/nextjs folder
npx baseai dev

By doing this, the Next.js example will use the local packages instead of the published ones.

Docs

Docs are written in markdown and are present inside the apps/baseai.dev/content/docs directory.

The docs in content/docs are categorized into sections. Each section is a directory and each page is a markdown file inside the directory.

To add a new page in a section, create a new markdown file inside the section directory.

The file name should be in kebab case.
The file should have a frontmatter with the following fields:

---
title: "<REPLACE-WITH-TITLE>"
description: "<REPLACE-WITH-DESCRIPTION>"
tags:
    - <REPLACE-WITH-TAGS>
    - <REPLACE-WITH-TAGS>
section: "<REPLACE-WITH-SECTION>"
published: 2024-09-24
modified: 2024-09-24
---

The following is an example of a frontmatter:

---
title: "BaseAI CLI"
description: "CLI reference of BaseAI CLI."
tags:
    - baseai
    - cli
    - langbase
section: "Getting Started"
published: 2024-09-24
modified: 2024-09-24
---

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!