diff options
| author | Mahesh Sanikommmu <[email protected]> | 2025-10-08 17:06:53 -0700 |
|---|---|---|
| committer | Mahesh Sanikommmu <[email protected]> | 2025-10-08 17:06:53 -0700 |
| commit | 0fc6d27e7a2089fd4ae18224527d776caf66c733 (patch) | |
| tree | 9e2d91cbcb68c15777e632417b60f8e6b4193b13 | |
| parent | Revert "test(ai-sdk): streamText and generateText for ai sdk" (#466) (diff) | |
| download | supermemory-0fc6d27e7a2089fd4ae18224527d776caf66c733.tar.xz supermemory-0fc6d27e7a2089fd4ae18224527d776caf66c733.zip | |
fix(docs): repo links and spell checks
| -rw-r--r-- | CONTRIBUTING.md | 19 | ||||
| -rw-r--r-- | README.md | 2 |
2 files changed, 15 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3ea376f..42e9316b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,8 +16,8 @@ Before you begin, ensure you have the following installed: 1. **Fork and Clone the Repository** ```bash - git clone https://github.com/your-username/supermemory-app.git - cd supermemory-app + git clone https://github.com/supermemoryai/supermemory.git + cd supermemory ``` 2. **Install Dependencies** @@ -49,17 +49,26 @@ Before you begin, ensure you have the following installed: supermemory is organized as a monorepo using Turbo: ``` -supermemory-app/ +supermemory/ ├── apps/ -│ └── web/ # Next.js web application +│ ├── web/ # Next.js web application +│ ├── browser-extension/ # Browser extension (WXT-based) +│ ├── docs/ # Documentation site +│ └── raycast-extension/ # Raycast extension ├── packages/ │ ├── ui/ # Shared UI components │ ├── lib/ # Shared utilities and logic │ ├── hooks/ # Shared React hooks │ ├── validation/ # Zod schemas and validation +│ ├── ai-sdk/ # AI SDK for memory operations +│ ├── tools/ # Development tools and utilities +│ ├── openai-sdk-python/ # Python SDK for OpenAI integration +│ ├── openai-sdk-ts/ # TypeScript SDK for OpenAI integration │ ├── eslint-config/ # ESLint configurations │ └── typescript-config/ # TypeScript configurations -└── turbo.json # Turbo configuration +├── turbo.json # Turbo configuration +├── biome.json # Biome configuration +└── package.json # Root package configuration ``` ## 🛠️ Development Workflow @@ -18,7 +18,7 @@ Go to [app.supermemory.ai](https://app.supermemory.ai) and sign into with your account -1. <a id="add-memory"></a>Start Adding Memory with your choose of format (Note, Link, File) +1. <a id="add-memory"></a>Start Adding Memory with your choice of format (Note, Link, File) <div align="center" style="padding-bottom:10px;padding-top:10px"> <img src="apps/web/public/add-memory.png" alt="supermemory" width="100%" /> </div> |