@@ -4,15 +4,15 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44
55## Project Overview
66
7- This is the documentation website for Basic Memory (` docs.basicmemory.com ` ), built with Astro, React components, and MDX for content . The site provides comprehensive documentation including guides, integrations, how-to articles, and technical references.
7+ This is the documentation website for Basic Memory (` docs.basicmemory.com ` ), built with Docus (Nuxt-based documentation theme) . The site provides comprehensive documentation including guides, integrations, how-to articles, and technical references.
88
99### What is Basic Memory?
1010
1111** Basic Memory** is a user-first knowledge management system built on the Model Context Protocol (MCP) that enables persistent AI memory across conversations. Instead of losing valuable insights in conversation history, users build a persistent knowledge base where both human and AI can read, write, and enhance each other's work.
1212
1313** Repository** : https://github.com/basicmachines-co/basic-memory
1414** Website** : https://basicmemory.com
15- ** Current Version** : v0.18.0 (released January 26 , 2026)
15+ ** Current Version** : v0.18.0 (released January 28 , 2026)
1616
1717** Key Features** :
1818- 17 MCP tools for AI integration (write_note, read_note, edit_note, search_notes, build_context, etc.)
@@ -23,14 +23,11 @@ This is the documentation website for Basic Memory (`docs.basicmemory.com`), bui
2323- Real-time file synchronization
2424- SQLite and PostgreSQL database backends
2525
26- ** v0.18.x Major Features** :
27- - Directory operations - move and delete entire directories with MCP tools
28- - Local/cloud routing flags - ` --local ` and ` --cloud ` CLI flags for explicit routing control
29- - Cloud snapshots - create, list, browse, and restore point-in-time snapshots
30- - API v2 migration complete - all MCP tools use optimized v2 endpoints
31- - Auto-format files on save with built-in Python formatter
32- - Cloud mode stability improvements
33- - PostgreSQL/Neon database support as alternative to SQLite
26+ ** v0.18.0 Major Features** :
27+ - Context-aware wiki link resolution with source_path support
28+ - Directory support for move_note and delete_note tools
29+ - Local MCP cloud mode routing for simultaneous local/cloud usage
30+ - Cloud snapshot CLI commands for backup management
3431
3532### Basic Memory Cloud
3633
@@ -62,159 +59,123 @@ This documentation site covers both:
62591 . ** Basic Memory** (local-first product) - Installation, MCP tools, CLI, integrations, knowledge format
63602 . ** Basic Memory Cloud** (upcoming) - Cloud-specific features, authentication, sync, billing
6461
65- The site documents the latest v0.18 .x release and includes cloud product documentation.
62+ The site documents the latest v0.17 .x release and includes cloud product documentation.
6663
6764## Development Commands
6865
6966``` bash
7067npm install # Install dependencies
71- npm run dev # Start dev server at localhost:4321
72- npm run build # Build production site to ./dist/
68+ npm run dev # Start dev server at localhost:3000
69+ npm run build # Build production site
7370npm run preview # Preview production build locally
74- npm run astro ... # Run Astro CLI commands
71+ just deploy development # Deploy to development environment
72+ just deploy production # Deploy to production environment
7573```
7674
7775## Architecture
7876
7977### Tech Stack
80- - ** Framework** : Astro 5 with MDX and React integration
81- - ** Styling** : Tailwind CSS with custom design tokens
82- - ** Components ** : React (TSX) and Astro components
83- - ** Search** : Pagefind for static search
84- - ** Diagrams ** : Mermaid integration with theme support
85- - ** Syntax Highlighting ** : Shiki with GitHub light/dark themes
78+ - ** Framework** : Docus (Nuxt 4-based documentation theme)
79+ - ** Styling** : Tailwind CSS 4 with Nuxt UI
80+ - ** Content ** : Markdown with MDC syntax
81+ - ** Search** : Built-in full-text search
82+ - ** LLM Integration ** : nuxt-llms for AI-friendly documentation
83+ - ** Deployment ** : Fly.io with Docker containerization
8684
8785### Directory Structure
8886
8987```
90- src /
91- ├── components/ # React and Astro components
92- │ ├ ── *.tsx # React components (Callout, Card, CodeBlock, Tabs, etc.)
93- │ └── *.astro # Astro components (Header, Sidebar, Footer, etc. )
94- ├── config/
95- │ └ ── navigation.ts # Navigation configuration
96- ├── layouts/
97- │ ├── Layout.astro # Base layout
98- │ └ ── DocsLayout.astro # Docs page layout with sidebar + TOC
99- ├── lib/
100- │ └ ── utils.ts # Utility functions (cn, etc.)
101- ├ ── pages / # File-based routing
102- │ ├── index.mdx
103- │ ├── guides/
104- │ ├── integrations/
105- │ ├── how-to/
106- │ └── technical/
107- └── styles/ # Global styles and CSS variables
88+ ├── app /
89+ │ ├── app.config.ts # Docus configuration
90+ │ └ ── components/ # Custom Vue components
91+ ├── content/ # Documentation pages (Markdown )
92+ │ ├── 1.start-here/ # Getting started guides
93+ │ ├ ── 2.whats-new/ # Release notes
94+ │ ├── 3.cloud/ # Cloud documentation
95+ │ ├── 4.local/ # Local installation
96+ │ ├ ── 5.concepts/ # Core concepts
97+ │ ├── 6.integrations/ # Integration guides
98+ │ ├ ── 7.how-to/ # How-to guides
99+ │ └ ── 8.reference / # Technical reference
100+ ├── public/ # Static assets
101+ ├── server/ # Server routes (API)
102+ ├── nuxt.config.ts # Nuxt configuration
103+ ├── Dockerfile # Container build
104+ ├── fly.toml.template # Fly.io deployment template
105+ └── justfile # Development commands
108106```
109107
110108### Key Architectural Patterns
111109
112- ** Navigation System** (` src/config/navigation.ts ` ):
113- - Centralized configuration for all navigation
114- - ` navConfig.sidebar ` : Hierarchical sidebar structure with sections and items
115- - ` navConfig.sidebarTopLinks ` : External links with icons (GitHub, Discord, etc.)
116- - ` navConfig.topNav ` : Top navigation links
117- - Interface: ` SidebarSection ` containing ` NavItem[] `
110+ ** Configuration** (` app/app.config.ts ` ):
111+ - Docus theme configuration (header, footer, socials, TOC)
112+ - Nuxt UI color and component customization
118113
119- ** Layout Composition ** :
120- - ` Layout.astro ` : Base layout with head/meta tags
121- - ` DocsLayout.astro ` : Three-column layout (Sidebar → Content → TableOfContents)
122- - Uses frontmatter ` layout ` field in MDX files
114+ ** Navigation ** :
115+ - File-based routing via numbered directory prefixes (e.g., ` 1.start-here/ ` )
116+ - ` .navigation.yml ` files for section titles and icons
117+ - Automatic sidebar generation from content structure
123118
124119** Component System** :
125- - Documentation components exported from ` src/components/index.ts `
126- - Custom components available in MDX: ` Card ` , ` CardGroup ` , ` Callout ` , ` Tip ` , ` Warning ` , ` Note ` , ` Info ` , ` Steps ` , ` Tabs ` , ` CodeBlock ` , ` CodeGroup ` , ` InstallationTabs `
127- - All use Tailwind CSS with dark mode support via ` class ` strategy
128-
129- ** Path Aliases** :
130- - ` @/* ` maps to ` ./src/* ` (configured in tsconfig.json)
131- - Always use ` @/components ` , ` @/config ` , etc. for imports
120+ - MDC (Markdown Components) syntax for inline components
121+ - Custom Vue components in ` app/components/content/ `
122+ - Built-in Docus components: ` ::note ` , ` ::warning ` , ` ::tip ` , ` ::code-group `
132123
133124** Theming** :
134- - Dark mode: Class-based (` darkMode: 'class' ` in Tailwind)
135- - Theme toggle component with localStorage persistence
136- - Custom CSS variables in Tailwind config for design tokens
137- - Mermaid diagrams support light/dark themes
125+ - Dark mode built-in with Nuxt UI
126+ - Tailwind CSS 4 with CSS variables
127+ - Theme configuration in ` app/app.config.ts `
138128
139129## Content Guidelines
140130
141131### Adding Documentation Pages
142132
143- 1 . Create MDX file in appropriate ` src/pages/ ` subdirectory
144- 2 . Add frontmatter:
133+ 1 . Create ` .md ` file in appropriate ` content/ ` subdirectory
134+ 2 . Use numeric prefix for ordering (e.g., ` 1.getting-started.md ` )
135+ 3 . Add frontmatter:
145136 ``` yaml
146137 ---
147- layout : ' @/layouts/DocsLayout.astro'
148- title : ' Page Title'
149- description : ' Optional description'
138+ title : Page Title
139+ description : Optional description
150140 ---
151141 ```
152- 3 . Add navigation entry to ` src/config/navigation.ts ` in correct section
153- 4 . Import and use documentation components as needed
154-
155- ### Using Components in MDX
156142
157- ``` mdx
158- import { Card , CardGroup , Callout , Steps } from ' @/components'
143+ ### Using MDC Components
159144
160- <Callout type = " info" >
161- Important information here
162- </Callout >
145+ ``` md
146+ :: note
147+ Important information here
148+ ::
163149
164- <Steps >
165- 1 . First step
166- 2 . Second step
167- </Steps >
150+ :: warning
151+ Warning message
152+ ::
168153
169- <CardGroup cols = { 2 } >
170- <Card title = " Guide 1" href = " /guide-1" />
171- <Card title = " Guide 2" href = " /guide-2" />
172- </CardGroup >
154+ :: code-group
155+ ``` bash [npm]
156+ npm install basic-memory
173157```
174-
175- ## Navigation Updates
176-
177- When adding/removing/reorganizing pages, update ` src/config/navigation.ts ` :
178-
179- ``` typescript
180- export const navConfig = {
181- sidebar: [
182- {
183- title: ' Section Name' ,
184- items: [
185- { title: ' Page Title' , href: ' /path/to/page' },
186- ],
187- },
188- ],
189- }
158+ ``` bash [pip]
159+ pip install basic-memory
160+ ```
161+ ::
190162```
191-
192- The sidebar automatically highlights the current page based on ` href ` matching ` Astro.url.pathname ` .
193-
194- ## Styling Conventions
195-
196- - Use Tailwind utility classes
197- - Dark mode: Add ` dark: ` variants for all colors
198- - Responsive: Mobile-first with ` md: ` and ` lg: ` breakpoints
199- - Custom colors use HSL CSS variables from Tailwind config
200- - Components should support both light and dark themes
201163
202164## Site Configuration
203165
204- - Site URL: ` https://docs.basicmemory.com ` (in astro.config.mjs)
205- - Mermaid diagrams use 'default' (light) and 'base' (dark) themes
206- - Shiki syntax highlighting uses 'github-light' and 'github-dark'
207- - Pagefind builds search index automatically during production build
166+ - Site URL: ` https://docs.basicmemory.com ` (in nuxt.config.ts)
167+ - Docus configuration in ` app/app.config.ts `
168+ - LLM-friendly output via nuxt-llms module
208169
209170## Documentation Status & Priorities
210171
211- Documentation is up-to-date for v0.18 .x release. Cloud product documentation is complete.
172+ Documentation is up-to-date for v0.17 .x release. Cloud product documentation is complete.
212173
213174### Reference Materials
214175
215176When documenting features:
216177- ** Basic Memory CHANGELOG** : ` gh api repos/basicmachines-co/basic-memory/contents/CHANGELOG.md `
217- - ** Release Notes** : ` gh release view v0.18.0 --repo basicmachines-co/basic-memory `
178+ - ** Release Notes** : ` gh release view v0.17.2 --repo basicmachines-co/basic-memory `
218179- ** Basic Memory README** : https://github.com/basicmachines-co/basic-memory
219180- ** Cloud README** : https://github.com/basicmachines-co/basic-memory-cloud
220181- ** Cloud CLAUDE.md** : https://github.com/basicmachines-co/basic-memory-cloud/blob/main/CLAUDE.md
0 commit comments