mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-08-28 05:25:33 +00:00
fix(docs): repo links and spell checks
This commit is contained in:
parent
1e2657cf5c
commit
0fc6d27e7a
2 changed files with 15 additions and 6 deletions
|
|
@ -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>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue