From 0fc6d27e7a2089fd4ae18224527d776caf66c733 Mon Sep 17 00:00:00 2001 From: Mahesh Sanikommmu Date: Wed, 8 Oct 2025 17:06:53 -0700 Subject: [PATCH] fix(docs): repo links and spell checks --- CONTRIBUTING.md | 19 ++++++++++++++----- 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 diff --git a/README.md b/README.md index 83c88559..6fff5a3d 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Go to [app.supermemory.ai](https://app.supermemory.ai) and sign into with your account -1. Start Adding Memory with your choose of format (Note, Link, File) +1. Start Adding Memory with your choice of format (Note, Link, File)
supermemory