Skip to content

Commit 0d3b770

Browse files
ThomasK33ThomasK33
authored
docs: remove dbmem references from documentation files (#18861)
Change-Id: Ic33bc383d00d0e354c25a0dd6080a4307d9862b6 Signed-off-by: Thomas Kosiewski <tk@coder.com>
1 parent 7c66dcd commit 0d3b770

File tree

6 files changed

+96
-22
lines changed

6 files changed

+96
-22
lines changed

‎.claude/docs/DATABASE.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222

2323
### Helper Scripts
2424

25-
| Script | Purpose |
26-
|--------|---------|
27-
| `./coderd/database/migrations/create_migration.sh "migration name"` | Creates new migration files |
28-
| `./coderd/database/migrations/fix_migration_numbers.sh` | Renumbers migrations to avoid conflicts |
29-
| `./coderd/database/migrations/create_fixture.sh "fixture name"` | Creates test fixtures for migrations |
25+
| Script | Purpose |
26+
|---------------------------------------------------------------------|-----------------------------------------|
27+
| `./coderd/database/migrations/create_migration.sh "migration name"` | Creates new migration files |
28+
| `./coderd/database/migrations/fix_migration_numbers.sh` | Renumbers migrations to avoid conflicts |
29+
| `./coderd/database/migrations/create_fixture.sh "fixture name"` | Creates test fixtures for migrations |
3030

3131
### Database Query Organization
3232

@@ -214,6 +214,5 @@ make lint
214214
- [ ] Migration files exist (both up and down)
215215
- [ ] `make gen` run after query changes
216216
- [ ] Audit table updated for new fields
217-
- [ ] In-memory database implementations updated
218217
- [ ] Nullable fields use `sql.Null*` types
219218
- [ ] Authorization context appropriate for endpoint type

‎.claude/docs/OAUTH2.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ Before completing OAuth2 or authentication feature work:
151151
- [ ] Update RBAC permissions for new resources
152152
- [ ] Add audit logging support if applicable
153153
- [ ] Create database migrations with proper defaults
154-
- [ ] Update in-memory database implementations
155154
- [ ] Add comprehensive test coverage including edge cases
156155
- [ ] Verify linting compliance
157156
- [ ] Test both positive and negative scenarios

‎.claude/docs/TROUBLESHOOTING.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -116,20 +116,33 @@ When facing multiple failing tests or complex integration issues:
116116

117117
### Useful Debug Commands
118118

119-
| Command | Purpose |
120-
|---------|---------|
121-
| `make lint` | Run all linters |
122-
| `make gen` | Generate mocks, database queries |
119+
| Command | Purpose |
120+
|----------------------------------------------|---------------------------------------|
121+
| `make lint` | Run all linters |
122+
| `make gen` | Generate mocks, database queries |
123123
| `go test -v ./path/to/package -run TestName` | Run specific test with verbose output |
124-
| `go test -race ./...` | Run tests with race detector |
124+
| `go test -race ./...` | Run tests with race detector |
125125

126126
### LSP Debugging
127127

128-
| Command | Purpose |
129-
|---------|---------|
130-
| `mcp__go-language-server__definition symbolName` | Find function definition |
131-
| `mcp__go-language-server__references symbolName` | Find all references |
132-
| `mcp__go-language-server__diagnostics filePath` | Check for compilation errors |
128+
#### Go LSP (Backend)
129+
130+
| Command | Purpose |
131+
|----------------------------------------------------|------------------------------|
132+
| `mcp__go-language-server__definition symbolName` | Find function definition |
133+
| `mcp__go-language-server__references symbolName` | Find all references |
134+
| `mcp__go-language-server__diagnostics filePath` | Check for compilation errors |
135+
| `mcp__go-language-server__hover filePath line col` | Get type information |
136+
137+
#### TypeScript LSP (Frontend)
138+
139+
| Command | Purpose |
140+
|----------------------------------------------------------------------------|------------------------------------|
141+
| `mcp__typescript-language-server__definition symbolName` | Find component/function definition |
142+
| `mcp__typescript-language-server__references symbolName` | Find all component/type usages |
143+
| `mcp__typescript-language-server__diagnostics filePath` | Check for TypeScript errors |
144+
| `mcp__typescript-language-server__hover filePath line col` | Get type information |
145+
| `mcp__typescript-language-server__rename_symbol filePath line col newName` | Rename across codebase |
133146

134147
## Common Error Messages
135148

@@ -197,6 +210,8 @@ When facing multiple failing tests or complex integration issues:
197210

198211
- Check existing similar implementations in codebase
199212
- Use LSP tools to understand code relationships
213+
- For Go code: Use `mcp__go-language-server__*` commands
214+
- For TypeScript/React code: Use `mcp__typescript-language-server__*` commands
200215
- Read related test files for expected behavior
201216

202217
### External Resources

‎.claude/docs/WORKFLOWS.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,11 @@
127127

128128
## Code Navigation and Investigation
129129

130-
### Using Go LSP Tools (STRONGLY RECOMMENDED)
130+
### Using LSP Tools (STRONGLY RECOMMENDED)
131131

132-
**IMPORTANT**: Always use Go LSP tools for code navigation and understanding. These tools provide accurate, real-time analysis of the codebase and should be your first choice for code investigation.
132+
**IMPORTANT**: Always use LSP tools for code navigation and understanding. These tools provide accurate, real-time analysis of the codebase and should be your first choice for code investigation.
133+
134+
#### Go LSP Tools (for backend code)
133135

134136
1. **Find function definitions** (USE THIS FREQUENTLY):
135137
- `mcp__go-language-server__definition symbolName`
@@ -145,14 +147,49 @@
145147
- `mcp__go-language-server__hover filePath line column`
146148
- Get type information and documentation at specific positions
147149

150+
#### TypeScript LSP Tools (for frontend code in site/)
151+
152+
1. **Find component/function definitions** (USE THIS FREQUENTLY):
153+
- `mcp__typescript-language-server__definition symbolName`
154+
- Example: `mcp__typescript-language-server__definition LoginPage`
155+
- Quickly navigate to React components, hooks, and utility functions
156+
157+
2. **Find symbol references** (ESSENTIAL FOR UNDERSTANDING IMPACT):
158+
- `mcp__typescript-language-server__references symbolName`
159+
- Locate all usages of components, types, or functions
160+
- Critical for refactoring React components and understanding prop usage
161+
162+
3. **Get type information**:
163+
- `mcp__typescript-language-server__hover filePath line column`
164+
- Get TypeScript type information and JSDoc documentation
165+
166+
4. **Rename symbols safely**:
167+
- `mcp__typescript-language-server__rename_symbol filePath line column newName`
168+
- Rename components, props, or functions across the entire codebase
169+
170+
5. **Check for TypeScript errors**:
171+
- `mcp__typescript-language-server__diagnostics filePath`
172+
- Get compilation errors and warnings for a specific file
173+
148174
### Investigation Strategy (LSP-First Approach)
149175

176+
#### Backend Investigation (Go)
177+
150178
1. **Start with route registration** in `coderd/coderd.go` to understand API endpoints
151-
2. **Use LSP `definition` lookup** to trace from route handlers to actual implementations
152-
3. **Use LSP `references`** to understand how functions are called throughout the codebase
179+
2. **Use Go LSP `definition` lookup** to trace from route handlers to actual implementations
180+
3. **Use Go LSP `references`** to understand how functions are called throughout the codebase
153181
4. **Follow the middleware chain** using LSP tools to understand request processing flow
154182
5. **Check test files** for expected behavior and error patterns
155183

184+
#### Frontend Investigation (TypeScript/React)
185+
186+
1. **Start with route definitions** in `site/src/App.tsx` or router configuration
187+
2. **Use TypeScript LSP `definition`** to navigate to React components and hooks
188+
3. **Use TypeScript LSP `references`** to find all component usages and prop drilling
189+
4. **Follow the component hierarchy** using LSP tools to understand data flow
190+
5. **Check for TypeScript errors** with `diagnostics` before making changes
191+
6. **Examine test files** (`.test.tsx`) for component behavior and expected props
192+
156193
## Troubleshooting Development Issues
157194

158195
### Common Issues

‎CLAUDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,19 @@
4747

4848
### LSP Navigation (USE FIRST)
4949

50+
#### Go LSP (for backend code)
51+
5052
- **Find definitions**: `mcp__go-language-server__definition symbolName`
5153
- **Find references**: `mcp__go-language-server__references symbolName`
5254
- **Get type info**: `mcp__go-language-server__hover filePath line column`
55+
- **Rename symbol**: `mcp__go-language-server__rename_symbol filePath line column newName`
56+
57+
#### TypeScript LSP (for frontend code in site/)
58+
59+
- **Find definitions**: `mcp__typescript-language-server__definition symbolName`
60+
- **Find references**: `mcp__typescript-language-server__references symbolName`
61+
- **Get type info**: `mcp__typescript-language-server__hover filePath line column`
62+
- **Rename symbol**: `mcp__typescript-language-server__rename_symbol filePath line column newName`
5363

5464
### OAuth2 Error Handling
5565

‎site/CLAUDE.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Frontend Development Guidelines
22

3+
## TypeScript LSP Navigation (USE FIRST)
4+
5+
When investigating or editing TypeScript/React code, always use the TypeScript language server tools for accurate navigation:
6+
7+
- **Find component/function definitions**: `mcp__typescript-language-server__definition ComponentName`
8+
- Example: `mcp__typescript-language-server__definition LoginPage`
9+
- **Find all usages**: `mcp__typescript-language-server__references ComponentName`
10+
- Example: `mcp__typescript-language-server__references useAuthenticate`
11+
- **Get type information**: `mcp__typescript-language-server__hover site/src/pages/LoginPage.tsx 42 15`
12+
- **Check for errors**: `mcp__typescript-language-server__diagnostics site/src/pages/LoginPage.tsx`
13+
- **Rename symbols**: `mcp__typescript-language-server__rename_symbol site/src/components/Button.tsx 10 5 PrimaryButton`
14+
- **Edit files**: `mcp__typescript-language-server__edit_file` for multi-line edits
15+
316
## Bash commands
417

518
- `pnpm dev` - Start Vite development server
@@ -42,10 +55,11 @@
4255

4356
## Workflow
4457

45-
- Be sure to typecheck when you’re done making a series of code changes
58+
- Be sure to typecheck when you're done making a series of code changes
4659
- Prefer running single tests, and not the whole test suite, for performance
4760
- Some e2e tests require a license from the user to execute
4861
- Use pnpm format before creating a PR
62+
- **ALWAYS use TypeScript LSP tools first** when investigating code - don't manually search files
4963

5064
## Pre-PR Checklist
5165

0 commit comments

Comments
 (0)