wehub-resource-sync
555e282cc4
pi-agent-plugin checks / lint (push) Has been cancelled
pi-agent-plugin checks / test (20) (push) Has been cancelled
pi-agent-plugin checks / test (22) (push) Has been cancelled
pi-agent-plugin checks / build (push) Has been cancelled
TypeScript SDK CI / check_changes (push) Has been cancelled
TypeScript SDK CI / changelog_check (push) Has been cancelled
ci / changelog_check (push) Has been cancelled
ci / check_changes (push) Has been cancelled
ci / build_mem0 (3.10) (push) Has been cancelled
ci / build_mem0 (3.11) (push) Has been cancelled
ci / build_mem0 (3.12) (push) Has been cancelled
CLI Node CI / lint (push) Has been cancelled
CLI Node CI / test (20) (push) Has been cancelled
CLI Node CI / test (22) (push) Has been cancelled
CLI Node CI / build (push) Has been cancelled
CLI Python CI / lint (push) Has been cancelled
CLI Python CI / test (3.10) (push) Has been cancelled
CLI Python CI / test (3.11) (push) Has been cancelled
CLI Python CI / test (3.12) (push) Has been cancelled
CLI Python CI / build (push) Has been cancelled
openclaw checks / lint (push) Has been cancelled
openclaw checks / test (20) (push) Has been cancelled
openclaw checks / test (22) (push) Has been cancelled
openclaw checks / build (push) Has been cancelled
opencode-plugin checks / build (push) Has been cancelled
TypeScript SDK CI / build_ts_sdk (20) (push) Has been cancelled
TypeScript SDK CI / build_ts_sdk (22) (push) Has been cancelled
TypeScript SDK CI / integration_ts_sdk (20) (push) Has been cancelled
TypeScript SDK CI / integration_ts_sdk (22) (push) Has been cancelled
57 lines
1.0 KiB
Plaintext
57 lines
1.0 KiB
Plaintext
---
|
|
title: Documentation
|
|
description: "Guide to contributing documentation to Mem0, including Mintlify setup, prerequisites, and local preview steps."
|
|
icon: "book"
|
|
---
|
|
|
|
# Documentation Contributions
|
|
|
|
## Prerequisites
|
|
|
|
Before getting started, ensure you have **Node.js (version 23.6.0 or higher)** installed on your system.
|
|
|
|
---
|
|
|
|
## Setting Up Mintlify
|
|
|
|
### Step 1: Install Mintlify
|
|
|
|
Install Mintlify globally using your preferred package manager:
|
|
|
|
<CodeGroup>
|
|
|
|
```bash npm
|
|
npm i -g mintlify
|
|
```
|
|
|
|
```bash yarn
|
|
yarn global add mintlify
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
### Step 2: Run the Documentation Server
|
|
|
|
Navigate to the `docs/` directory (where `docs.json` is located) and start the development server:
|
|
|
|
```bash
|
|
mintlify dev
|
|
```
|
|
|
|
The documentation website will be available at: [http://localhost:3000](http://localhost:3000).
|
|
|
|
---
|
|
|
|
## Custom Ports
|
|
|
|
By default, Mintlify runs on **port 3000**. To use a different port, add the `--port` flag:
|
|
|
|
```bash
|
|
mintlify dev --port 3333
|
|
```
|
|
|
|
---
|
|
|
|
By following these steps, you can efficiently contribute to Mem0's documentation.
|
|
|