Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .claude/agents/Agent-1-mdx-release-notes-generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,13 @@ You must structure all release notes with exactly these three sections in this e
- **Explicitly mention when new wireframes are introduced** (e.g., "preview wireframes")
- Never include deprecated API code blocks to avoid confusion

### Linking Standards
- **Add "Learn More" links** after each major feature bullet point linking to the relevant full documentation section
- **Link all data model references**: When mentioning interface/type names like `Context`, `SetDocumentsContext`, `PermissionQuery`, etc., format as links: [`Context`](/api-reference/sdk/models/data-models#context)
- **Link all API method references**: When mentioning methods like `setDocuments()`, `setPermissionProvider()`, format as links: [`setDocuments()`](/api-reference/sdk/api/api-methods#setdocuments)
- **Link placement**: Add links in descriptive text, but NEVER in code examples or code comments
- **Example**: "Enhanced Permission Provider to support context-based permission requests. [Learn more about Permission Provider →](/key-concepts/overview#c-real-time-permission-provider)"

### Terminology Standards
- **React Code Examples**: Always use `client` for API methods (e.g., `const recorderElement = client.getRecorderElement()`)
- **HTML Code Examples**: Never use the word "client"; always replace with "Velt" (e.g., `const recorderElement = Velt.getRecorderElement()`)
Expand Down
19 changes: 16 additions & 3 deletions .claude/agents/Agent-3-models-and-methods-updater.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,15 @@ When adding or updating API methods:
2. **Categorize appropriately** (hooks vs REST APIs vs SDK methods)
3. **Follow established parameter documentation** patterns
4. **Include return type information** with links to data-models.mdx - **verify return types are accurate** (e.g., `requestScreenPermission` returns `Promise<MediaStream | null>`)
5. **Provide usage examples** following React-first, Other Frameworks-second pattern
6. **Document all parameters** with types, required/optional status, and descriptions
7. **Include error handling** and edge case information where relevant
5. **CRITICAL: API methods page format** - NEVER include implementation details, code examples, or configuration options on the api-methods.mdx page. Only show:
- Brief description (1-2 sentences)
- Params: with link to data model definition (e.g., [`VeltPermissionProvider`](/api-reference/sdk/models/data-models#veltpermissionprovider))
- Returns: return type
- React Hook: hook name or `n/a`
- [Full Documentation →] link to comprehensive implementation guide
6. **All implementation details** (code examples, configuration options, prerequisites, usage notes) belong in the linked full documentation page, NOT on api-methods.mdx
7. **Document all parameters** with types, required/optional status, and descriptions
8. **Include error handling** and edge case information where relevant

## Quality Assurance Framework

Expand Down Expand Up @@ -73,6 +79,13 @@ Before finalizing updates:
- Specify default values and constraints clearly
- Group related types logically within sections

### Linking Standards
- **Link all data model references**: When referencing types/interfaces in descriptions, format as links: [`Context`](/api-reference/sdk/models/data-models#context)
- **Link all API method references**: When referencing methods, format as links: [`setDocuments()`](/api-reference/sdk/api/api-methods#setdocuments)
- **Link placement**: Add links in descriptive text and documentation prose, but NEVER in code examples or code comments
- **Parameter types**: Always link parameter types to their data model definitions (e.g., `Params: [`VeltPermissionProvider`](/api-reference/sdk/models/data-models#veltpermissionprovider)`)
- **Cross-references**: Link between related types and methods throughout the documentation

### API Documentation
- Document all parameters with complete type information
- Include usage examples for each method or hook
Expand Down
10 changes: 10 additions & 0 deletions .claude/agents/Agent-4-ui-customization-updater.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,16 @@ Before finalizing updates:
- **Update related UI customization pages** as needed
- **Ensure examples work** with current SDK versions

### Linking Standards
- **Link all data model references**: When referencing types/interfaces in descriptive text, format as links: [`Context`](/api-reference/sdk/models/data-models#context)
- **Link all API method references**: When referencing methods in descriptive text, format as links: [`setDocuments()`](/api-reference/sdk/api/api-methods#setdocuments)
- **CRITICAL: Link placement restriction**: Add links ONLY in descriptive text and documentation prose. NEVER add links within code examples or code comments
- **Code examples must remain clean**: Keep all code snippets free of markdown links to maintain readability and copyability
- **Example of correct usage**:
- ✅ In prose: "The [`setDocuments()`](/api-reference/sdk/api/api-methods#setdocuments) method uses the [`SetDocumentsContext`](/api-reference/sdk/models/data-models#setdocumentscontext) interface"
- ❌ In code: `// see [Context](/api-reference/sdk/models/data-models#context) for more info`
- ✅ In code: `// see Context interface for more info`

## Implementation Standards

### Wireframe Documentation
Expand Down
15 changes: 15 additions & 0 deletions .claude/agents/Agent-5-documentation-alignment-enforcer.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,21 @@ Avoid changes in:
- **Create bidirectional links**: When Agent-3 adds new API methods or new API methods are metnioned that already exist in api-methods.mdx, ensure feature documentation subsections link back to the API reference using the format: `### [methodName](/api-reference/sdk/api/api-methods#anchor)`
- Example: `### [enableHeartbeat](/api-reference/sdk/api/api-methods#enableheartbeat)`

### Linking Verification Standards
- **Verify all data model references are linked**: Check that types/interfaces like `Context`, `SetDocumentsContext`, `PermissionQuery` are formatted as links: [`Context`](/api-reference/sdk/models/data-models#context)
- **Verify all API method references are linked**: Check that methods like `setDocuments()`, `setPermissionProvider()` are formatted as links: [`setDocuments()`](/api-reference/sdk/api/api-methods#setdocuments)
- **CRITICAL: Link verification scope**: Verify links ONLY in descriptive text and documentation prose. NEVER check for or add links within code examples or code comments
- **Code comments standards**:
- Comments should ONLY explain the code itself (what it does, why, how)
- Comments should NOT reference documentation, type definitions, or "see X for more info"
- Comments should focus purely on code functionality and logic
- **Validation approach**:
- ✅ Verify prose has links: "The [`setDocuments()`](/api-reference/sdk/api/api-methods#setdocuments) method..."
- ✅ Good code comment: `// Enable context-based permission requests`
- ✅ Good code comment: `// Optional: Only present when isContextEnabled is true`
- ❌ Bad code comment: `// see Context interface for more info`
- ❌ Bad code comment: `// Optional - see [Context](/api-reference/sdk/models/data-models#context)`

## Quality Assurance Framework

### Comprehensive Validation
Expand Down
18 changes: 18 additions & 0 deletions .claude/agents/Agent-6-qa-terminology-aligner.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,24 @@ Before executing replacements:
- **Validate change map completeness** across all variants
- **Test search patterns** for false positives

### Linking Verification Standards
- **Verify all data model references are linked**: Ensure types/interfaces like `Context`, `SetDocumentsContext`, `PermissionQuery` are formatted as links in prose: [`Context`](/api-reference/sdk/models/data-models#context)
- **Verify all API method references are linked**: Ensure methods like `setDocuments()`, `setPermissionProvider()` are formatted as links in prose: [`setDocuments()`](/api-reference/sdk/api/api-methods#setdocuments)
- **CRITICAL: Link verification scope**: Verify links ONLY in descriptive text and documentation prose. NEVER check for or require links within code examples or code comments
- **Code comment standards**:
- Comments must ONLY explain the code itself (what it does, why, how)
- Comments must NOT reference documentation, type definitions, or include "see X for more info" language
- Comments must focus purely on code functionality and logic
- Comments must not contain markdown link syntax
- **Validation checklist**:
- ✅ Prose has proper links: "The [`setDocuments()`](/api-reference/sdk/api/api-methods#setdocuments) method..."
- ✅ Good code comment: `// Enable context-based permission requests`
- ✅ Good code comment: `// Optional: Only present when isContextEnabled is true`
- ✅ API methods page shows only: params, returns, hook, full documentation link (NO implementation details)
- ❌ Bad code comment: `// see Context interface for more info` (references documentation)
- ❌ Bad code comment: `// see PermissionQuery for full definition` (references documentation)
- ❌ Bad code comment: `// Optional - see [Context](/api-reference/sdk/models/data-models#context)` (has markdown link)

### Post-Replacement Verification
After executing replacements:
- **Scan for missed references** using alternative patterns
Expand Down
Loading