@brainfish-ai/devdoc 0.1.32 → 0.1.34

package/ai-agents/.claude/skills/docs-from-code/SKILL.md

@@ -1,73 +0,0 @@
----
-name: docs-from-code
-description: Generate documentation from specific code files, functions, or modules
----
-
-## Instructions
-
-When generating docs from specific code:
-
-1. Analyze the code structure and purpose
-2. Identify:
-   - Public API/exports
-   - Function signatures and parameters
-   - Return types and values
-   - Usage patterns from tests or examples
-3. Generate documentation with:
-   - Overview of the module/function
-   - Parameter descriptions
-   - Code examples
-   - Common use cases
-
-## Output Format
-
-```mdx
----
-title: "{Module/Function Name}"
-description: "{Brief purpose}"
----
-
-{Overview paragraph}
-
-## Installation
-
-{If applicable}
-
-## Usage
-
-<Steps>
-  <Step title="Import">
-    ```typescript
-    import { function } from 'package';
-    ```
-  </Step>
-  <Step title="Basic Usage">
-    {Example code}
-  </Step>
-</Steps>
-
-## API Reference
-
-### `functionName(params)`
-
-{Description}
-
-**Parameters:**
-| Name | Type | Description |
-|------|------|-------------|
-| param1 | `type` | Description |
-
-**Returns:** `type` - Description
-
-## Examples
-
-{Practical examples with code blocks}
-```
-
-## Best Practices
-
-1. Extract real code examples - don't fabricate
-2. Include TypeScript types when available
-3. Show common use cases
-4. Document edge cases and error handling
-5. Link to related functions/modules

package/ai-agents/.claude/skills/generate-api-docs/SKILL.md

@@ -1,94 +0,0 @@
----
-name: generate-api-docs
-description: Generate API documentation pages from OpenAPI spec or code
----
-
-## Instructions
-
-1. Analyze the OpenAPI spec or API code
-2. Create documentation pages for:
-   - Introduction/Overview
-   - Authentication guide
-   - Error handling
-   - Rate limiting (if applicable)
-3. Update docs.json to include API reference tab
-
-## OpenAPI Tab Configuration
-
-```json
-{
-  "tab": "API Reference",
-  "type": "openapi",
-  "path": "/api-reference",
-  "spec": "api-reference/openapi.json",
-  "groups": [
-    {
-      "group": "Overview",
-      "pages": ["api-reference/introduction", "api-reference/authentication"]
-    }
-  ]
-}
-```
-
-## GraphQL Tab Configuration
-
-```json
-{
-  "tab": "GraphQL API",
-  "type": "graphql",
-  "path": "/graphql-api",
-  "schema": "api-reference/schema.graphql",
-  "endpoint": "https://api.example.com/graphql"
-}
-```
-
-## Generated Pages
-
-### api-reference/introduction.mdx
-```mdx
----
-title: "API Introduction"
-description: "Overview of the API"
----
-
-Brief overview of the API capabilities.
-
-## Base URL
-
-\`\`\`
-https://api.example.com/v1
-\`\`\`
-
-## Authentication
-
-All requests require authentication. See [Authentication](/api-reference/authentication).
-```
-
-### api-reference/authentication.mdx
-```mdx
----
-title: "Authentication"
-description: "How to authenticate API requests"
----
-
-<Tabs>
-  <Tab title="Bearer Token">
-    Include the token in the Authorization header:
-    \`\`\`bash
-    curl -H "Authorization: Bearer YOUR_TOKEN" https://api.example.com/v1/users
-    \`\`\`
-  </Tab>
-  <Tab title="API Key">
-    Include the API key in the header:
-    \`\`\`bash
-    curl -H "X-API-Key: YOUR_KEY" https://api.example.com/v1/users
-    \`\`\`
-  </Tab>
-</Tabs>
-```
-
-## After Generating
-
-1. Review and customize the generated content
-2. Add real examples from your API
-3. Update authentication details

package/ai-agents/.claude/skills/sync-docs/SKILL.md

@@ -1,112 +0,0 @@
----
-name: sync-docs
-description: Analyze existing documentation against codebase and identify/fix outdated content
----
-
-## Instructions
-
-When syncing documentation with the codebase:
-
-### Step 1: Build Documentation Inventory
-
-Scan all MDX files and extract:
-- Documented functions, classes, components
-- Code examples and their imports
-- API endpoints referenced
-- Package versions mentioned
-- CLI commands documented
-
-### Step 2: Analyze Current Codebase
-
-Compare documentation against source code:
-- Check if documented functions still exist
-- Verify function signatures match (parameters, return types)
-- Confirm API endpoints are still valid
-- Check if package versions are current
-- Identify new exports not yet documented
-
-### Step 3: Generate Sync Report
-
-Output a report categorizing issues:
-
-```
-## Documentation Sync Report
-
-### Outdated (Breaking Changes)
-- `docs/api/users.mdx`: `createUser()` signature changed
-  - Documented: `createUser(name: string)`
-  - Current: `createUser(data: UserInput)`
-
-### Outdated (Minor Changes)  
-- `docs/quickstart.mdx`: Package version outdated
-  - Documented: `v1.2.0`
-  - Current: `v1.5.0`
-
-### Missing Documentation
-- `src/utils/validator.ts` - New export, not documented
-- `POST /api/v2/webhooks` - New endpoint, not documented
-
-### Up to Date
-- `docs/guides/authentication.mdx`
-- `docs/components/button.mdx`
-```
-
-### Step 4: Update Options
-
-Ask user preference:
-1. **Auto-fix all** - Update all outdated docs automatically
-2. **Interactive** - Review each change before applying
-3. **Report only** - Just show the report, don't change anything
-
-### Step 5: Apply Updates
-
-When updating:
-- Preserve existing prose and explanations
-- Update code examples to match current signatures
-- Add TODO markers for sections needing human review
-- Update version numbers
-- Add stubs for missing documentation
-
-## Detection Patterns
-
-| Documentation Pattern | Codebase Check |
-|----------------------|----------------|
-| `import { X } from 'pkg'` | Verify X is exported from pkg |
-| `function X(a, b)` | Check X signature in source |
-| `v1.2.3` version strings | Compare with package.json |
-| `POST /api/users` | Verify route exists |
-| `<Component prop={x}>` | Check component props interface |
-
-## Update Strategies
-
-### For Changed Function Signatures
-```mdx
-// Before (outdated)
-createUser(name: string, email: string)
-
-// After (updated)
-createUser(data: UserInput)
-// Where UserInput = { name: string, email: string, role?: string }
-```
-
-### For Removed Features
-```mdx
-<Warning>
-**Deprecated**: This feature was removed in v2.0. 
-See [migration guide](/guides/v2-migration) for alternatives.
-</Warning>
-```
-
-### For New Features (stub)
-```mdx
----
-title: "New Feature"
-description: "Description"
----
-
-{/* TODO: Document this feature */}
-
-## Overview
-
-Coming soon...
-```

package/ai-agents/.claude/skills/update-docs-json/SKILL.md

@@ -1,60 +0,0 @@
----
-name: update-docs-json
-description: Add new pages to docs.json navigation configuration
----
-
-## Instructions
-
-When updating docs.json:
-
-1. Read the current docs.json structure
-2. Identify the appropriate group for the new page
-3. Add the page path (without .mdx extension)
-4. Maintain consistent ordering (introductory pages first)
-
-## Navigation Structure
-
-```json
-{
-  "navigation": {
-    "tabs": [
-      {
-        "tab": "Tab Name",
-        "type": "docs",
-        "groups": [
-          {
-            "group": "Group Name",
-            "icon": "phosphor-icon-name",
-            "pages": ["page-path", "folder/page-path"]
-          }
-        ]
-      }
-    ]
-  }
-}
-```
-
-## Page Path Format
-
-- Use relative paths from docs root
-- Omit the `.mdx` extension
-- Use forward slashes for nested paths
-- Examples: `"quickstart"`, `"guides/authentication"`
-
-## Common Icons (Phosphor)
-
-- `rocket-launch` - Getting started
-- `book-open` - Documentation
-- `terminal` - CLI/Commands
-- `gear` - Configuration
-- `code` - Development
-- `puzzle-piece` - Components
-- `key` - Authentication
-- `cloud-arrow-up` - Deployment
-
-## Best Practices
-
-1. Group related pages together
-2. Order pages from basic to advanced
-3. Use descriptive group names
-4. Keep navigation depth shallow (max 2 levels)

package/ai-agents/.cursor/rules/devdoc-sync.mdc

@@ -1,70 +0,0 @@
----
-description: Rules for syncing and updating documentation with codebase changes
-globs: ["**/*.mdx", "**/docs.json"]
----
-
-# Documentation Sync Rules
-
-When asked to sync, update, or check documentation:
-
-## Analysis Process
-
-1. Compare documented APIs against source code exports
-2. Verify code examples compile/run correctly
-3. Check version numbers match package.json
-4. Validate all internal links resolve
-5. Identify new features needing documentation
-
-## Common Outdated Patterns
-
-- Function signatures that changed
-- Removed or renamed exports
-- Changed configuration options
-- Updated CLI commands
-- New required parameters
-- Deprecated features still documented
-
-## Update Guidelines
-
-- Preserve existing explanations and prose
-- Only update technical details (code, signatures, versions)
-- Add TODO comments for sections needing human review
-- Create stubs for undocumented new features
-- Mark deprecated features with Warning callout
-
-## Detection Checklist
-
-| Check | How to Verify |
-|-------|---------------|
-| Function exists | Search source for export |
-| Signature matches | Compare params and return type |
-| Version current | Check package.json |
-| Route exists | Search API routes |
-| Component props | Check TypeScript interface |
-
-## Update Patterns
-
-### Changed Signature
-Update the documented signature to match source.
-
-### Removed Feature
-Add deprecation warning:
-```mdx
-<Warning>
-This feature was removed in vX.X.
-</Warning>
-```
-
-### New Feature
-Create stub with TODO:
-```mdx
-{/* TODO: Document this feature */}
-```
-
-## Report Format
-
-When checking docs, report:
-- Outdated items (with specific file:line)
-- Missing documentation
-- Broken links
-- Up-to-date items (summary)