👌 IMPROVE: Docs and Examples (#9)

* 🐛 FIX: Examples

* 👌 IMPROVE: Memory docs

* 👌 IMPROVE: Env docs

Author: ahmadbilaldev

apps/baseai.dev/content/docs/getting-started/environment-variables.mdx

@@ -48,8 +48,8 @@ Read more about [Langbase LLM Keysets](https://langbase.com/docs/features/keyset
 LANGBASE_API_KEY=
 
 # TODO: ADD: LOCAL ONLY. Add only to local env files.
-# Following keys are needed for local pipe runs. For providers you are using.
-# For Langbase, please add the key to your LLM keysets.
+# Following keys are needed for local pipe runs. Add keys of providers you are using.
+# For Langbase, please add the keys in your LLM keysets on Langbase Studio.
 # Read more: Langbase LLM Keysets https://langbase.com/docs/features/keysets
 OPENAI_API_KEY=
 ANTHROPIC_API_KEY=

apps/baseai.dev/content/docs/guides/nextjs-with-baseai.mdx

@@ -335,7 +335,7 @@ Refer to [Next.js with BaseAI](https://github.com/LangbaseInc/baseai/tree/main/e
 
 ## Step #9: Add environment variables
 
-To be able to run and later deploy your Next.js app, you need to add providers and Langbase API keys.
+To be able to run and later deploy your Next.js app, you need to add your Langbase and LLM provider keys. Add the following environment variables to your `.env` file at the root of your app.
 
 ```bash
 # !! SERVER SIDE ONLY !!
@@ -347,8 +347,8 @@ To be able to run and later deploy your Next.js app, you need to add providers a
 LANGBASE_API_KEY=
 
 # TODO: ADD: LOCAL ONLY. Add only to local env files.
-# Following keys are needed for local pipe runs. For providers you are using.
-# For Langbase, please add the key to your LLM keysets.
+# Following keys are needed for local pipe runs. Add the providers you are using.
+# For Langbase, please add the keys in your LLM keysets on Langbase Studio.
 # Read more: Langbase LLM Keysets https://langbase.com/docs/features/keysets
 OPENAI_API_KEY=
 ANTHROPIC_API_KEY=
@@ -370,7 +370,10 @@ TOGETHER_API_KEY=
 Run BaseAI dev server and start the Next.js app.
 
 ```bash
+# Terminal 1
 npx baseai@latest dev # Start BaseAI dev server
+
+# Terminal 2
 npm run dev # Start Next.js app
 ```
 

apps/baseai.dev/content/docs/memory/quickstart.mdx

@@ -42,7 +42,7 @@ Let's create a chat with docs system for [Pipe FAQs](https://langbase.com/docs/p
 Create a new memory using the `memory` command. It will ask you for name and description of the memory. Use `chat-with-docs` as the memory name.
 
 ```bash
-baseai memory
+npx baseai@latest memory
 ```
 
 It creates a memory at `baseai/memory/chat-with-docs` in your current directory. Add documents to `baseai/memory/chat-with-docs/documents` to use them in the memory.
@@ -60,7 +60,7 @@ OPENAI_API_KEY=your-openai-api-key
 Save [Pipe FAQs](https://langbase.com/docs/pipe/faqs) page as a `.pdf` or `.txt` and add it to the memory. Next, create embeddings for the documents using the `embed` command. It will embed the documents and create a semantic index for the memory. Pass the memory name to the `embed` command using the `--memory` flag or `-m` for short.
 
 ```bash
-baseai embed -m chat-with-docs
+npx baseai@latest embed -m chat-with-docs
 ```
 
 Once the embeddings are created, it will print a success message in the terminal.
@@ -72,7 +72,7 @@ Let's create a [Pipe](/docs/pipe/quickstart) and connect memory to it. Use the `
 Use `chat-with-docs-rag` as the pipe name and select the memory `chat-with-docs` to connect it to the pipe.
 
 ```bash
-baseai pipe
+npx baseai@latest pipe
 ```
 
 It will create a pipe in your current directory under `baseai/pipes/chat-with-docs-rag.ts`. It prints the path in the terminal. You can open the file and see the details.

examples/astro/README.md

@@ -5,6 +5,9 @@ BaseAI Astro example.
 Please read the [documentation](https://baseai.dev/docs) for more information.
 
 ```sh
+# Install the dependencies
+npm install
+
 # Make sure to copy .env.baseai.example file and
 # create .env file and add all the API keys in it
 cp .env.baseai.example .env

examples/nodejs/.env.example

@@ -73,3 +73,5 @@ assets/img/.DS_Store
 
 # Next.js
 .next
+# baseai
+/.baseai/

examples/nodejs/.gitignore

@@ -2,7 +2,7 @@ import {PipeI} from '@baseai/core';
 import chatWithDocsMemory from '../memory/chat-with-docs';
 
 const buildPipe = (): PipeI => ({
-	apiKey: 'process.env.LANGBASE_USER_ORG_API_KEY', // Replace with your API key https://langbase.com/docs/api-reference/api-keys
+	apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
 	name: 'chat-with-docs',
 	description: '',
 	status: 'private',

examples/nodejs/baseai/pipes/chat-with-docs.ts

@@ -1,7 +1,7 @@
 import {PipeI} from '@baseai/core';
 
 const buildPipe = (): PipeI => ({
-	apiKey: 'process.env.LANGBASE_USER_ORG_API_KEY', // Replace with your API key https://langbase.com/docs/api-reference/api-keys
+	apiKey: process.env.LANGBASE_API_KEY!, // Replace with your API key https://langbase.com/docs/api-reference/api-keys
 	name: 'summary',
 	description: '',
 	status: 'private',

examples/nodejs/baseai/pipes/summary.ts

@@ -5,8 +5,12 @@ BaseAI Node.js examples.
 Please read the [documentation](https://baseai.dev/docs) for more information.
 
 ```sh
-# Make sure to copy .env.example file and create .env file and add all the API keys in it
-cp .env.example .env
+# Install the dependencies
+npm install
+
+# Make sure to copy .env.baseai.example file and
+# create .env file and add all the API keys in it
+cp .env.baseai.example .env
 
 # Run the local baseai dev server to test the examples (uses localhost:9000 port)
 npx baseai dev