Skip to content

Commit db091d9

Browse files
committed
fix: correct legacy folder refs, API endpoints, purge syntax in docs
1 parent c0baeef commit db091d9

2 files changed

Lines changed: 17 additions & 11 deletions

File tree

QUICK_START.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,10 @@ BBC automatically detects and configures:
9292

9393
**Only installed IDEs get configured** — BBC detects what's on your system.
9494

95-
Universal files (always created):
96-
- `.agent/rules/bbc_rules.md`
97-
- `.context/bbc_context.md`
98-
- `BBC_INSTRUCTIONS.md`
95+
Universal files (always created inside `.bbc/`):
96+
- `.bbc/bbc_context.md` — Human-readable context summary
97+
- `.bbc/bbc_rules.md` — AI coding rules
98+
- `.bbc/BBC_INSTRUCTIONS.md` — Universal AI instruction manifest
9999

100100
## 🛠️ All Commands
101101

@@ -108,7 +108,7 @@ bbc verify [path] # Check structural integrity
108108
bbc menu [path] # Interactive BBC menu
109109
bbc serve --port 3333 # Start REST API server
110110
bbc audit [path] # Audit BBC traces
111-
bbc purge [--force] # Complete BBC removal
111+
bbc purge [path] [--force] # Complete BBC removal
112112
bbc stop # Stop BBC daemon
113113
bbc status # Show system status
114114
```

USER_GUIDE.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ bbc start
6969
| `bbc menu [path]` | Interactive BBC menu |
7070
| `bbc serve --port 3333` | Start REST API server |
7171
| `bbc audit [path]` | Audit BBC traces in project |
72-
| `bbc purge [--force]` | Complete BBC removal |
72+
| `bbc purge [path] [--force]` | Complete BBC removal |
7373
| `bbc stop` | Stop BBC daemon |
7474
| `bbc status` | Show system status |
7575

@@ -117,10 +117,10 @@ When BBC runs `inject`, it:
117117
| DeepSeek Coder | `.deepseek/config.json` |
118118

119119
### Universal Files (Always Created)
120-
These are created regardless of IDE detection:
121-
- `.agent/rules/bbc_rules.md`Agent rules
122-
- `.context/bbc_context.md`Context summary
123-
- `BBC_INSTRUCTIONS.md` — Universal instructions
120+
These are created regardless of IDE detection, all inside the `.bbc/` directory:
121+
- `.bbc/bbc_context.md`Human-readable context summary
122+
- `.bbc/bbc_rules.md`Project coding rules injected into AI
123+
- `.bbc/BBC_INSTRUCTIONS.md` — Universal AI instruction manifest
124124
- `.gitignore` — Updated with BBC patterns
125125

126126
## 🔒 Sealing (Mühürleme)
@@ -159,7 +159,13 @@ bbc stop # Stop the daemon
159159
```bash
160160
bbc serve --port 3333
161161
# API available at http://127.0.0.1:3333
162-
# Endpoints: /health, /analyze, /context, /status
162+
# Endpoints:
163+
# GET /health → Server health + memory
164+
# GET /api/project_context → Full sealed BBC context
165+
# GET /api/symbol_analysis → Symbol graph + critical symbols
166+
# GET /api/stats → Token savings + stability stats
167+
# POST /api/analyze → Analyze a single file
168+
# POST /mcp → MCP gateway (Claude Desktop, Cursor)
163169
```
164170

165171
### Isolated vs Embedded Installation

0 commit comments

Comments
 (0)