Skip to content

Commit 56616db

Browse files
committed
docs: remove references to removed npm-app and backend packages
- Update common/knowledge.md to reference web, cli, sdk packages - Update ROADMAP.md with current Dec 2024 status - Update authentication.knowledge.md to remove npm-app references - Update packages/internal/src/knowledge.md package list - Update cli/knowledge.md to remove npm-app reference - Update knowledge.md referral system section
1 parent e41fb69 commit 56616db

File tree

6 files changed

+12
-13
lines changed

6 files changed

+12
-13
lines changed

ROADMAP.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
In general, we reevaulate plans day-by-day and thus the roadmap may change at any point.
1+
In general, we reevaluate plans day-by-day and thus the roadmap may change at any point.
22

3-
As of Oct 6th, here's what we're working on:
4-
- Brandon is rebuilding npm-app from the ground up with a snazzy TUI and reusing the SDK instead of a custom connection to the backend
5-
- Charles is moving backend logic to the SDK so more code is run locally.
6-
- James is building more powerful agents, especially "base2", which is the next-gen default codebuff agent. Try it with `codebuff --experimental`!
3+
As of Dec 2024, here's what we're working on:
4+
- The CLI has been rebuilt with a modern TUI using OpenTUI and React 19
5+
- Core functionality has been moved to the SDK for local execution, and our CLI now fully uses it!
6+
- Building more powerful agents, especially "base2", which is the next-gen default codebuff agent

authentication.knowledge.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Overview
44

5-
Codebuff implements secure authentication between CLI (npm-app), backend, and web application using fingerprint-based device identification.
5+
Codebuff implements secure authentication between the CLI and web application using fingerprint-based device identification.
66

77
## Core Authentication Flow
88

99
```mermaid
1010
sequenceDiagram
11-
participant CLI as npm-app
11+
participant CLI as CLI
1212
participant Web as web app
1313
participant DB as Database
1414
@@ -30,7 +30,7 @@ sequenceDiagram
3030
### 1. First Time Login / Missing Credentials
3131

3232
- CLI generates fingerprint from hardware info + 8 random bytes
33-
- Uses `calculateFingerprint()` in `npm-app/src/fingerprint.ts`
33+
- Uses `calculateFingerprint()` in the SDK
3434
- Continues to core flow with new fingerprintId
3535

3636
### 2. Logout Flow

cli/knowledge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -640,7 +640,7 @@ This prevents invalid children from reaching `TextNodeRenderable` while preservi
640640

641641
### Slash Commands (`/`)
642642

643-
Typing `/` opens a five-item slash menu above the input, mirroring npm-app commands.
643+
Typing `/` opens a five-item slash menu above the input.
644644

645645
**Navigation**:
646646

common/knowledge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Common Package Knowledge
22

3-
This package contains code shared between the `web` (Next.js frontend/backend) and `backend` (CLI backend) packages.
3+
This package contains code shared across the Codebuff monorepo, including the `web` (Next.js), `cli`, and `sdk` packages.
44

55
## Key Areas
66

knowledge.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -334,12 +334,11 @@ Important constants are centralized in `common/src/constants.ts`:
334334

335335
## Referral System
336336

337-
**IMPORTANT**: Referral codes must be applied through the npm-app CLI, not through the web interface.
337+
**IMPORTANT**: Referral codes must be applied through the CLI, not through the web interface.
338338

339339
- Web onboarding flow shows instructions for entering codes in CLI
340340
- Users must type their referral code in the Codebuff terminal after login
341341
- Auto-redemption during web login was removed to prevent abuse
342-
- The `handleReferralCode` function in `npm-app/src/client.ts` handles CLI redemption
343342
- The `redeemReferralCode` function in `web/src/app/api/referrals/helpers.ts` processes the actual credit granting
344343

345344
### OAuth Referral Code Preservation

packages/internal/src/knowledge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Purpose
44

5-
Centralized location for internal utilities, environment configuration, and select integrations used across the Codebuff monorepo (`backend` and `web`).
5+
Centralized location for internal utilities, environment configuration, and select integrations used across the Codebuff monorepo (`web`, `cli`, and `sdk`).
66

77
## Structure
88

0 commit comments

Comments
 (0)