Skip to content

Commit bd871ac

Browse files
committed
move docs around remove irrelevant scripts etc
1 parent 7ad5372 commit bd871ac

48 files changed

Lines changed: 168 additions & 545431 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTS.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
- `forest.db` is a sample database for local smoke tests; feel free to reset it when experimenting.
99

1010
## Build, Test, and Development Commands
11-
- `npm run build` compiles TypeScript to `dist/` with the repo tsconfig.
12-
- `npm run dev` executes the CLI through `tsx`, ideal for iterating on commands without compiling.
13-
- `npm run lint` runs `tsc --noEmit` for type safety; treat failures as blockers.
14-
- `npm start` runs the compiled CLI (`node dist/index.js`); use it when verifying release artifacts.
11+
- `bun run build` compiles TypeScript to `dist/` with the repo tsconfig.
12+
- `bun run dev` executes the CLI through `tsx`, ideal for iterating on commands without compiling.
13+
- `bun run lint` runs `tsc --noEmit` for type safety; treat failures as blockers.
14+
- `bun run start` runs the compiled CLI (`bun run dist/index.js`); use it when verifying release artifacts.
1515

1616
## Coding Style & Naming Conventions
1717
- Follow the existing 2-space indentation, single quotes, and trailing commas where they clarify multi-line structures.
@@ -21,7 +21,7 @@
2121
## Testing Guidelines
2222
- There is no automated test suite yet; for new features, add targeted TypeScript tests alongside the code (e.g., `src/lib/__tests__/graph.spec.ts`) using `tsx` or `ts-node`.
2323
- Cover edge cases around scoring thresholds, tag extraction, and graph linking; include fixtures under a nearby `fixtures/` folder if needed.
24-
- Run `npm run dev -- capture --body "example"` against a fresh `forest.db` to perform smoke tests before submitting.
24+
- Run `bun run dev -- capture --body "example"` against a fresh `forest.db` to perform smoke tests before submitting.
2525

2626
## Commit & Pull Request Guidelines
2727
- Write concise, imperative commit subjects (e.g., “Add capture preview summary”), mirroring the existing history.

CLAUDE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,15 @@ cd tldr-agent-spec
8686
## Development Commands
8787

8888
```bash
89-
npm install # Install dependencies
90-
npm run build # Compile TypeScript to dist/
91-
npm run lint # Type-check without emitting files
92-
npm run dev # Run from source with ts-node
89+
bun install # Install dependencies
90+
bun run build # Compile TypeScript to dist/
91+
bun run lint # Type-check without emitting files
92+
bun run dev # Run from source with ts-node
9393

9494
# Testing the CLI during development
95-
npm run dev -- capture --stdin < test.txt
96-
npm run dev -- health
97-
npm run dev -- stats
95+
bun run dev -- capture --stdin < test.txt
96+
bun run dev -- health
97+
bun run dev -- stats
9898

9999
# Running the API server
100100
bun run dev:server # Start on default port 3000 (dual-stack IPv4/IPv6)

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ A graph-native knowledge base that captures ideas and automatically links them u
55
## Quick Start
66

77
```bash
8-
npm install
9-
npm run build
8+
bun install
9+
bun run build
1010

1111
# Capture ideas from different sources
1212
forest capture --stdin < idea.txt
@@ -78,10 +78,16 @@ forest node read abc12345 --raw | glow # Pipe to markdown viewer
7878
forest node read abc12345 --json
7979
```
8080

81-
**Edit** existing notes:
81+
**Edit** existing notes with your editor:
8282
```bash
83-
forest node edit abc12345 --title "New title"
84-
forest node edit abc12345 --stdin < updated.md
83+
forest node edit abc12345
84+
forest node edit abc12345 --editor "code --wait"
85+
```
86+
87+
**Refresh** notes from flags or files:
88+
```bash
89+
forest node refresh abc12345 --title "New title"
90+
forest node refresh abc12345 --stdin < updated.md
8591
```
8692

8793
**Synthesize** combines multiple notes into new perspectives:
@@ -397,15 +403,15 @@ TLDR v0.2 provides condensed command metadata optimized for LLM consumption (60%
397403

398404
```bash
399405
# Build from source
400-
npm run build
406+
bun run build
401407

402408
# Type checking
403-
npm run lint
409+
bun run lint
404410

405411
# Run from source
406-
npm run dev -- capture --stdin
412+
bun run dev -- capture --stdin
407413

408-
# Start API server (requires Bun)
414+
# Start API server
409415
bun run dev:server
410416
```
411417

bun.lock

Lines changed: 127 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/BRANCHING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ Forest uses a minimal **master + next** branching strategy.
5454
```bash
5555
git checkout next
5656
# Run tests, verify everything works
57-
npm run build
58-
npm run lint
57+
bun run build
58+
bun run lint
5959
```
6060

6161
2. **Merge next to master:**
@@ -67,7 +67,7 @@ Forest uses a minimal **master + next** branching strategy.
6767
3. **Bump version:**
6868
```bash
6969
# Update package.json and src/cli/commands/version.ts
70-
npm run build
70+
bun run build
7171
git add package.json src/cli/commands/version.ts
7272
git commit -m "Bump version to X.Y.Z"
7373
```
@@ -127,7 +127,7 @@ git checkout next
127127
git checkout master
128128
git merge next
129129
# Update version files
130-
npm run build
130+
bun run build
131131
git add package.json src/cli/commands/version.ts
132132
git commit -m "Bump version to 0.3.0"
133133
git tag -a v0.3.0 -m "Release v0.3.0"

docs/GIT_STYLE_REFERENCES.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,7 @@ All commands that accept node refs now support all patterns:
176176

177177
- **`forest node read [ref]`** - Works with `@`, `#tag`, `"title"`, UUID prefix
178178
- **`forest node edit [ref]`** - Same
179+
- **`forest node refresh [ref]`** - Same
179180
- **`forest node delete [ref]`** - Same
180181
- **`forest node link [ref1] [ref2]`** - Both refs support all patterns
181182

@@ -195,7 +196,7 @@ forest node read @<TAB> # Suggests @, @1, @2, @3, @4, @5
195196
fpath=(path/to/forest/completions $fpath)
196197
autoload -Uz compinit && compinit
197198

198-
forest node <TAB> # Shows: read, edit, delete, link, recent, ...
199+
forest node <TAB> # Shows: read, edit, refresh, delete, link, recent, ...
199200
```
200201

201202
## Documentation
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)