34 lines
1.3 KiB
Markdown
34 lines
1.3 KiB
Markdown
# `.claude/` — project-local knowledge
|
|
|
|
This folder is **committed to the repo** on purpose. It holds knowledge that helps both human
|
|
developers and Claude Code sessions work in this codebase — kept **local to the project**, not
|
|
in anyone's global profile, so it travels with the code and everyone benefits.
|
|
|
|
## Contents
|
|
|
|
- **[`ONBOARDING.md`](ONBOARDING.md)** — start here. How to run it, the mental model, where
|
|
things live, and how to add a feature end-to-end.
|
|
- **[`memory/`](memory/)** — durable, one-fact-per-file notes about *why* things are the way
|
|
they are (decisions, the design system sampled from LynkedUp Pro, conventions, the IIOS
|
|
relationship). `memory/MEMORY.md` is the index.
|
|
- **`settings.json`** — project Claude Code settings (a permission allowlist for common dev
|
|
commands so you get fewer prompts).
|
|
|
|
## Conventions for memory notes
|
|
|
|
Each note in `memory/` is a single Markdown file with frontmatter:
|
|
|
|
```markdown
|
|
---
|
|
name: kebab-case-slug
|
|
description: one line used to judge relevance
|
|
metadata:
|
|
type: project | reference | feedback | user
|
|
---
|
|
|
|
The fact. Link related notes with [[their-slug]].
|
|
```
|
|
|
|
When you learn something non-obvious about this project, add or update a note and add a line to
|
|
`memory/MEMORY.md`. Prefer updating an existing note over creating a duplicate.
|