Skip to content

Commit 6e82617

Browse files
phernandezphernandez
committed
update README.md
1 parent 3a18abd commit 6e82617

File tree

1 file changed

+130
-30
lines changed

1 file changed

+130
-30
lines changed

‎README.md‎

Lines changed: 130 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,147 @@
1-
# Astro Starter Kit: Minimal
1+
q# Basic Memory Documentation
22

3-
```sh
4-
npm create astro@latest -- --template minimal
3+
Official documentation site for [Basic Memory](https://basicmemory.com) - a local-first knowledge management system built on the Model Context Protocol (MCP).
4+
5+
🌐 **Live Site:** [docs.basicmemory.com](https://docs.basicmemory.com)
6+
7+
## About
8+
9+
This repository contains the complete documentation for Basic Memory, including:
10+
11+
- Getting Started guides
12+
- User Guide and AI Assistant Guide
13+
- MCP Tools Reference
14+
- Integration guides (Claude Desktop, ChatGPT, VS Code, Cursor, Obsidian)
15+
- Cloud features documentation
16+
- CLI Reference
17+
- Release notes and What's New
18+
19+
## Tech Stack
20+
21+
- **Framework:** [Astro](https://astro.build) with React components
22+
- **Styling:** Tailwind CSS
23+
- **Components:** Custom documentation components (Note, Warning, Info, etc.)
24+
- **Content:** MDX (Markdown + JSX)
25+
26+
## Development
27+
28+
### Prerequisites
29+
30+
- Node.js 18+
31+
- npm or pnpm
32+
33+
### Setup
34+
35+
```bash
36+
# Install dependencies
37+
npm install
38+
39+
# Start dev server
40+
npm run dev
541
```
642

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
43+
The site will be available at `http://localhost:4321`
1044

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
45+
### Commands
1246

13-
## 🚀 Project Structure
47+
| Command | Action |
48+
|---------|--------|
49+
| `npm install` | Install dependencies |
50+
| `npm run dev` | Start dev server at `localhost:4321` |
51+
| `npm run build` | Build production site to `./dist/` |
52+
| `npm run preview` | Preview production build locally |
1453

15-
Inside of your Astro project, you'll see the following folders and files:
54+
## Project Structure
1655

17-
```text
18-
/
19-
├── public/
56+
```
57+
docs.basicmemory.com/
58+
├── public/ # Static assets
2059
├── src/
21-
│ └── pages/
22-
│ └── index.astro
23-
└── package.json
60+
│ ├── components/ # React components (Note, Warning, etc.)
61+
│ ├── config/ # Site configuration (navigation, etc.)
62+
│ ├── layouts/ # Page layouts
63+
│ ├── pages/ # Documentation pages (MDX)
64+
│ │ ├── guides/ # User and developer guides
65+
│ │ ├── integrations/ # Integration-specific docs
66+
│ │ ├── how-to/ # Use case examples
67+
│ │ └── technical/ # Technical deep dives
68+
│ └── styles/ # Global styles
69+
└── .claude/
70+
└── agents/ # Claude Code agent definitions
2471
```
2572

26-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
73+
## Contributing Documentation
74+
75+
### Writing Style
76+
77+
- **Factual and clear** - No embellishment or marketing language
78+
- **Present tense** - Describe what features do, not what they will do
79+
- **Practical examples** - Include working code examples from actual usage
80+
- **Consistent terminology** - Use terms as defined in the codebase
81+
82+
### Adding New Pages
83+
84+
1. Create `.mdx` file in appropriate directory under `src/pages/`
85+
2. Add frontmatter with title, description, and optional icon
86+
3. Update navigation in `src/config/navigation.ts`
87+
4. Use standard components: `<Note>`, `<Warning>`, `<Info>`, `<Tip>`
88+
89+
Example:
90+
91+
```mdx
92+
---
93+
layout: '@/layouts/DocsLayout.astro'
94+
title: 'Page Title'
95+
description: 'Brief description'
96+
---
97+
98+
import { Note, Warning, Info } from '@/components'
99+
100+
<Note>
101+
Important information for readers
102+
</Note>
103+
104+
## Section
105+
106+
Content here...
107+
```
108+
109+
### Documentation Components
110+
111+
- `<Note>` - General information
112+
- `<Warning>` - Important warnings
113+
- `<Info>` - Highlighted information
114+
- `<Tip>` - Helpful tips
115+
- `<Steps>` / `<Step>` - Step-by-step instructions
116+
- `<Accordion>` / `<AccordionItem>` - Collapsible sections
117+
118+
### AI Agent for Documentation
119+
120+
This repository includes a Claude Code agent for documentation writing:
121+
122+
`.claude/agents/basic-memory-docs-writer.md`
123+
124+
Use this agent for:
125+
- Creating new documentation pages
126+
- Updating existing documentation
127+
- Ensuring consistent style and tone
128+
129+
## Deployment
27130

28-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
131+
Documentation is automatically deployed from the `main` branch.
29132

30-
Any static assets, like images, can be placed in the `public/` directory.
133+
## Related Repositories
31134

32-
## 🧞 Commands
135+
- [basic-memory](https://github.com/basicmachines-co/basic-memory) - Main Basic Memory repository
136+
- [basicmemory.com](https://github.com/basicmachines-co/basicmemory.com) - Product marketing site
137+
- [basicmachines.co](https://github.com/basicmachines-co/basicmachines.co) - Company website
33138

34-
All commands are run from the root of the project, from a terminal:
139+
## License
35140

36-
| Command | Action |
37-
| :------------------------ | :----------------------------------------------- |
38-
| `npm install` | Installs dependencies |
39-
| `npm run dev` | Starts local dev server at `localhost:4321` |
40-
| `npm run build` | Build your production site to `./dist/` |
41-
| `npm run preview` | Preview your build locally, before deploying |
42-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
43-
| `npm run astro -- --help` | Get help using the Astro CLI |
141+
See the main [Basic Memory repository](https://github.com/basicmachines-co/basic-memory) for license information.
44142

45-
## 👀 Want to learn more?
143+
## Support
46144

47-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
145+
- [Discord](https://discord.gg/tyvKNccgqN) - Community support
146+
- [GitHub Issues](https://github.com/basicmachines-co/basic-memory/issues) - Bug reports and feature requests
147+
- [Reddit](https://www.reddit.com/r/basicmemory) - Community discussions

0 commit comments

Comments
 (0)