brainfish-ai/reasondb/create-doc

# Find files related to the topic
git ls-files | grep -iE "(auth|login|session)"  # for auth docs
 
# Search file contents for specific terms
rg -l "export.*function.*createUser" --type ts
rg -l "class.*Authentication" --type ts
 
# Find types and interfaces
rg -l "interface.*User|type.*User" --type ts
 
# Find examples
git ls-files | grep -iE "(example|test|spec)"

┌─────────────────────────────────────────────┐
│ ASSESSMENT                                  │
├─────────────────────────────────────────────┤
│ ✅ Sufficient - Found source files          │
│    → Proceed with real data                 │
│                                             │
│ ⚠️ Partial - Some gaps                      │
│    → Generate with TODOs for gaps           │
│                                             │
│ ❌ Insufficient - No relevant files         │
│    → FLAG and offer options                 │
└─────────────────────────────────────────────┘

⚠️ UNCLEAR TOPIC: [topic]
 
Searched for:
  - src/**/*auth*.ts → Not found
  - lib/**/*auth*.ts → Not found
 
Options:
  1. 🔄 **Skip this doc** - Remove from plan
  2. ✏️  **Different topic** - Document something else
  3. 📝 **Mark as TODO** - Create placeholder
  4. ❓ **Ask for path** - "Where is [topic] implemented?"
 
Choose an option (1-4):

# Find feature flag patterns
rg -l "featureFlag|feature_flag|isEnabled|FF_" --type ts
rg "if.*\(.*feature|process\.env\.FEATURE" --type ts
rg "LaunchDarkly|Unleash|Split|flagsmith" --type ts

# Find similar function names
rg "export.*(login|authenticate|signIn)" --type ts -l
rg "export.*(createUser|addUser|registerUser)" --type ts -l

⚠️ FEATURE FLAGS DETECTED:
 
📍 src/lib/auth/index.ts:45
   if (featureFlags.newAuthFlow) { ... }
   
   This feature has TWO implementations:
   - OLD: lines 50-80 (current default)
   - NEW: lines 82-120 (behind feature flag)
   
   Question: Document which version?
   1. Current (old) implementation
   2. New implementation (feature flagged)
   3. Both with toggle notice
 
⚠️ DUPLICATE FEATURES DETECTED:
 
Found similar functions:
- src/lib/auth/login.ts → login()
- src/lib/auth/v2/authenticate.ts → authenticate()
- src/lib/legacy/signIn.ts → signIn()
 
Question: Which should be documented?
1. Document primary (login.ts)
2. Document all with comparison
3. Mark legacy as deprecated

📂 FILES FOUND for [topic]:
 
✓ src/lib/auth/index.ts (main auth module)
  - login(email, password): Promise<Token>
  - logout(): void
  - verifyToken(token): boolean
 
✓ src/lib/auth/types.ts
  - interface User { id, email, role }
  - type AuthToken { token, expiresAt }
 
✓ tests/auth.test.ts
  - Example usage patterns
 
⚠️ FEATURE FLAGS: newAuthFlow (src/lib/auth/index.ts:45)
⚠️ DUPLICATES: authenticate() in v2/, signIn() in legacy/
 
Proceed with generating documentation from these files?

═══════════════════════════════════════════════════════════
                    CONTENT REVIEW
═══════════════════════════════════════════════════════════
 
📄 FILE: docs/guides/authentication.mdx
 
───────────────────────────────────────────────────────────
                    DRAFT CONTENT
───────────────────────────────────────────────────────────
 
---
title: Authentication
description: Learn how to authenticate users in your app
sources: ["src/lib/auth/index.ts", "src/lib/auth/types.ts"]
---
 
## Overview
 
Authentication allows users to securely access your application...
 
## login(email, password)
 
Authenticate user and return JWT token.
 
| Parameter | Type | Description |
|-----------|------|-------------|
| email | string | User email address |
| password | string | User password |
 
**Returns:** `Promise<AuthToken>`
 
### Example
 

 
## Next Steps
 
...
 
───────────────────────────────────────────────────────────
                    NOTICES
───────────────────────────────────────────────────────────
 
⚠️ FEATURE FLAG: newAuthFlow
   This feature has a new implementation behind a flag.
   Currently documenting: OLD implementation
   
🔄 DUPLICATE: authenticate() exists in src/lib/auth/v2/
   Consider: Document both or mark one as preferred?
 
───────────────────────────────────────────────────────────
                    OPTIONS
───────────────────────────────────────────────────────────
 
1. ✅ **Approve** - Create file with this content
2. ✏️  **Edit** - Tell me what to change
3. 🔄 **Switch version** - Document feature-flagged version instead
4. ➕ **Add duplicate** - Include related feature documentation
5. ❌ **Cancel** - Don't create this file
 
Choose an option:

// Source: src/utils/auth.ts
export function validateToken(token: string): boolean {
  // ... implementation
}

## validateToken
 
Validates an authentication token.
 
### Parameters
 
| Parameter | Type | Description |
|-----------|------|-------------|
| `token` | `string` | The JWT token to validate |
 
### Returns
 
`boolean` - `true` if valid, `false` otherwise
 
### Example
 

# Source: src/auth.py
def validate_token(token: str) -> bool:
    """
    Validate an authentication token.
    
    Args:
        token: The JWT token to validate
        
    Returns:
        True if valid, False otherwise
    """

flowchart TB
    Client --> API
    API --> Auth
    API --> Service
    Service --> DB[(Database)]

sequenceDiagram
    Client->>API: POST /login
    API->>Auth: Validate
    Auth-->>API: Token
    API-->>Client: 200 OK