diff --git a/.roo/rules-docs-extractor/1_extraction_workflow.xml b/.roo/rules-docs-extractor/1_extraction_workflow.xml index 088fc1ae89fe..c707fa780924 100644 --- a/.roo/rules-docs-extractor/1_extraction_workflow.xml +++ b/.roo/rules-docs-extractor/1_extraction_workflow.xml @@ -1,296 +1,99 @@ - The Docs Extractor mode has two primary functions: - 1. Extract technical and non-technical details about features to provide to documentation teams - 2. Verify existing documentation for factual accuracy against the codebase - - This mode does not generate final documentation but provides detailed analysis and verification. + The Docs Extractor mode has exactly two workflow paths: + 1) Verify provided documentation for factual accuracy against the codebase + 2) Generate source material for user-facing docs about a requested feature or aspect of the codebase + + Outputs are designed to support explanatory documentation (not merely descriptive): + - Capture why users need steps and why certain actions are restricted + - Surface constraints, limitations, and trade‑offs + - Provide troubleshooting playbooks (symptoms → causes → fixes → prevention) + - Recommend targeted visuals for complex states (not step‑by‑step screenshots) + + This mode does not generate final user documentation; it produces verification and source-material reports for docs teams. Parse Request - Identify the feature or component in the user's request. - Determine if the request is for extraction or verification. - For extraction: Note what level of detail is needed (technical vs non-technical). - For verification: Identify the documentation to be verified. + Identify the feature/aspect in the user's request. + Decide path: verification vs. source-material generation. + For source-material: capture audience (user or developer) and depth (overview vs task-focused). + For verification: identify the documentation to be verified (provided text/links/files). Note any specific areas to emphasize or check. - The mode branches into extraction or verification based on the request. Discover Feature - Locate relevant code using appropriate search methods. - Identify entry points and components. - Map the high-level architecture. - Use any combination of tools to understand the feature. + Locate relevant code and assets using appropriate discovery methods. + Identify entry points and key components that affect user experience. + Map the high-level workflow a user follows. - Use the most effective discovery method for the situation - file exploration, search, or direct navigation. - - - Code Analysis - - - Analyze code structure -
- - Identify classes, functions, modules - - Extract method signatures, parameters - - Document return types, data structures - - Map inheritance and composition -
- - - Extract APIs -
- - REST endpoints - - GraphQL schemas - - WebSocket events - - RPC interfaces -
- - - Document configuration -
- - Environment variables - - Config files and schemas - - Feature flags - - Runtime parameters -
- - - - - - UI/UX and User Experience Analysis - - - Analyze user interface components -
- - UI components and their interactions - - Forms, buttons, navigation elements - - Visual feedback and loading states - - Responsive design considerations - - Accessibility features -
- - - Map user journeys and interactions -
- - Step-by-step user workflows - - Click paths and navigation flows - - User decision points - - Input validation and error messaging - - Success and failure scenarios -
- - - Document user experience elements -
- - Page layouts and information architecture - - Interactive elements and their behaviors - - Tooltips, help text, and guidance - - Confirmation dialogs and warnings - - Progress indicators and status updates -
- - - Capture visual and behavioral patterns -
- - Color schemes and theming - - Animation and transitions - - Keyboard shortcuts and accessibility - - Mobile vs desktop experiences - - Browser-specific considerations -
- - - - - - Business Logic Extraction - - - Map workflows from user perspective -
- - User journey through the feature - - Decision points and branching - - State transitions visible to users - - Roles and permissions affecting UI -
- - - Document business rules -
- - Validation logic and user feedback - - Formulas and algorithms - - Business process implementations - - Compliance requirements -
- - - Identify use cases -
- - Primary use cases - - Edge cases - - Error scenarios and user recovery - - Performance factors affecting UX -
- - - - - - Dependency Analysis - - - Map dependencies -
- - Third-party libraries - - External services and APIs - - Database connections - - Message queues -
- - - Document integration points -
- - Incoming webhooks - - Outgoing API calls - - Event publishers/subscribers - - Shared data stores -
- - - Analyze data flow -
- - Data sources and formats - - Data transformations - - Output formats and destinations - - Data retention policies -
- - - - - - Test Analysis - - - Assess test coverage -
- - Unit test coverage - - Integration test scenarios - - End-to-end test flows - - Performance test results -
- - - Document error handling -
- - Error types and codes - - Exception handling - - Fallback mechanisms - - Recovery procedures -
- - - Identify quality metrics -
- - Code complexity - - Performance benchmarks - - Security vulnerabilities - - Maintainability scores -
- - - - - - Security Analysis - - - Document security -
- - Auth mechanisms - - Access control - - Data encryption - - Security policies -
- - - Identify vulnerabilities -
- - Known security issues - - Attack vectors - - Mitigation - - Best practices -
- - - Check compliance -
- - Regulatory compliance (GDPR, etc.) - - Industry standards - - Audit trail requirements - - Data privacy -
- - - - + + UI components and their interactions + User workflows and decision points + Configuration that changes user-visible behavior + Error states, messages, and recovery + Benefits, limits, prerequisites, and version notes + Why this exists: user goals, constraints, and design intent + “Cannot do” boundaries: permissions, invariants, and business rules + Troubleshooting: symptoms, likely causes, diagnostics, fixes, prevention + Common pitfalls and anti‑patterns (what to avoid and why) + Decision rationale and trade‑offs that affect user choices + Complex UI states that merit visuals (criteria for screenshots/diagrams) + - - Extract Feature Details - Analyze and extract comprehensive details for documentation team + + Generate Source Material for User-Facing Docs + Extract concise, user-oriented facts and structure them for documentation teams. - Compile Technical Details + Scope and Audience - List all technical components and their relationships - Document APIs, data structures, and algorithms - Extract configuration options and their impacts - Identify error handling and edge cases - Note performance characteristics and limitations + Confirm the feature/aspect and intended audience. + List primary tasks the audience performs with this feature. - Extract Non-Technical Information + Extract User-Facing Facts - Describe complete user experience and workflows - Document UI interactions and visual elements - Explain business logic in plain language - Identify user benefits and use cases - Document common scenarios with UI context - Note prerequisites and user-facing dependencies - Capture error messages and user guidance + Summarize what the feature does and key benefits. + Explain why users need this (jobs-to-be-done, outcomes) and when to use it. + Document step-by-step user workflows and UI interactions. + Capture configuration options that impact user behavior (name, default, effect). + Clarify constraints, limits, and “cannot do” cases with rationale. + Identify common pitfalls and anti-patterns; include “Do/Don’t” guidance. + List common errors with user-facing messages, diagnostics, fixes, and prevention. + Record prerequisites, permissions, and compatibility/version notes. + Flag complex states that warrant visuals (what to show and why), not every step. - Create Extraction Report + Create Source Material Report - Organize findings into clear categories - Separate technical and non-technical information - Include code snippets and examples where helpful - Create `EXTRACTION-[feature].md` with findings - Highlight areas that need special attention in documentation + Organize findings using user-focused structure (benefits, use cases, how it works, configuration, FAQ, troubleshooting). + Include short code/UI snippets or paths where relevant. + Create `EXTRACTION-[feature].md` with findings. + Highlight items that need visuals (screenshots/diagrams). - - Executive summary of the feature - - UI/UX analysis and user experience - - Technical details section - - Non-technical/user-facing details + - Executive summary of the feature/aspect + - Why it matters (goals, value, when to use) - User workflows and interactions - - Configuration and setup information - - Common use cases with UI context - - Error handling and user guidance - - Potential documentation considerations + - Configuration and setup affecting users (with defaults and impact) + - Constraints and limitations (with rationale) + - Common scenarios and troubleshooting playbooks (symptoms → causes → fixes → prevention) + - Do/Don’t and anti‑patterns + - Recommended visuals (what complex states to illustrate and why) + - FAQ and tips + - Version/compatibility notes @@ -298,44 +101,43 @@ Verify Documentation Accuracy - Check existing documentation against codebase reality + Check provided documentation against codebase reality and actual UX. Analyze Provided Documentation - Parse the documentation to identify claims and descriptions - Extract technical specifications mentioned - Note user-facing features and workflows described - Identify configuration options and examples provided + Parse the documentation to identify claims and descriptions. + Extract technical or user-facing specifics mentioned. + Note workflows, configuration, and examples described. Verify Against Codebase - Check technical claims against actual implementation - Verify API endpoints, parameters, and responses - Confirm configuration options and defaults - Validate code examples and snippets - Check if described workflows match implementation + Check claims against actual implementation and UX. + Verify endpoints/parameters if referenced. + Confirm configuration options and defaults. + Validate code snippets and examples. + Ensure described workflows match implementation. Create Verification Report - Categorize findings by severity (Critical, Major, Minor) - List all inaccuracies with correct information - Identify missing important information - Note outdated or deprecated content - Provide specific corrections and suggestions - Create `VERIFICATION-[feature].md` with findings + Categorize findings by severity (Critical, Major, Minor). + List inaccuracies with the correct information. + Identify missing important information. + Provide specific corrections and suggestions. + Create `VERIFICATION-[feature].md` with findings. - Verification summary (Accurate/Needs Updates) - Critical inaccuracies that could mislead users - - Technical corrections needed - - Missing information that should be added + - Corrections and missing information + - Explanatory gaps (missing “why”, constraints, or decision rationale) + - Troubleshooting coverage gaps (missing symptoms/diagnostics/fixes/prevention) + - Visual recommendations (which complex states warrant screenshots/diagrams) - Suggestions for clarity improvements - - Overall recommendations @@ -343,13 +145,13 @@ - - All code paths analyzed - Technical details comprehensively extracted - Non-technical information clearly explained - Use cases and examples provided + + Audience and scope captured + User workflows and UI interactions documented + User-impacting configuration recorded + Common errors and troubleshooting documented Report organized for documentation team use - + All documentation claims verified Inaccuracies identified and corrected diff --git a/.roo/rules-docs-extractor/2_documentation_patterns.xml b/.roo/rules-docs-extractor/2_documentation_patterns.xml index ef1643d8a40e..da743483dabe 100644 --- a/.roo/rules-docs-extractor/2_documentation_patterns.xml +++ b/.roo/rules-docs-extractor/2_documentation_patterns.xml @@ -4,7 +4,7 @@ - # [Feature Name] [Description of what the feature does and why a user should care.] @@ -22,7 +22,7 @@ - [Pain point 1] - [Pain point 2] -**With this feature]**: [Description of the new experience.] +**With this feature**: [Description of the new experience.] ## How it Works @@ -58,9 +58,9 @@ - [Answer.] - [Optional tip.] - ]]> + - # [Feature Name] Technical Documentation ## Table of Contents @@ -71,28 +71,27 @@ 5. Configuration 6. User Guide 7. Developer Guide -8. Administrator Guide -9. Security -10. Performance -11. Troubleshooting -12. FAQ -13. Changelog -14. References - -[This template remains available for generating detailed technical documentation.] - ]]> +8. Security +9. Performance +10. Troubleshooting +11. FAQ +12. Changelog +13. References + +[Use this as an internal source-material outline for technical sections; not for final docs.] + - + @@ -101,7 +100,7 @@ - + @@ -123,7 +122,7 @@ - + - + - + Tutorials Use cases @@ -179,60 +178,31 @@ - - - Deployment - Monitoring - Security hardening - Backup and recovery - - - - - - - Business value - Capabilities and limits - Competitive advantages - Risk assessment - - - - + - + - + - + - + - + - + @@ -368,20 +338,20 @@ config: - + - + \ No newline at end of file diff --git a/.roo/rules-docs-extractor/3_analysis_techniques.xml b/.roo/rules-docs-extractor/3_analysis_techniques.xml index b9ef93d1f30d..12b3d1fd266f 100644 --- a/.roo/rules-docs-extractor/3_analysis_techniques.xml +++ b/.roo/rules-docs-extractor/3_analysis_techniques.xml @@ -1,55 +1,40 @@ - Techniques for analyzing code to extract documentation. + Heuristics for analyzing a codebase to extract reliable, user-facing documentation. + This file contains technique checklists only—no tool instructions or invocations. - - Find and analyze UI components and their interactions - - - - Search for UI component files - - -src -\.(tsx|jsx|vue)$|@Component|export.*component -*.tsx - - - - -src - - - ]]> - - - - Analyze styling and visual elements - - -src/styles -true - + Find and analyze UI components and their interactions + + Start from feature or route directories and enumerate components related to the requested topic. + Differentiate container vs presentational components; note composition patterns. + Trace inputs/outputs: props, state, context, events, and side effects. + Record conditional rendering that affects user-visible states. + + + Primary components and responsibilities. + Props/state/context that change behavior. + High-level dependency/composition map. + + - - -src -className=|style=|styled\.|makeStyles|@apply - - ]]> - - + + Analyze styling and visual elements + + Identify design tokens and utility classes used to drive layout and state. + Capture responsive behavior and breakpoint rules that materially change UX. + Document visual affordances tied to state (loading, error, disabled). + + + Key classes/selectors influencing layout/state. + Responsive behavior summary and breakpoints. + - - Map user interactions and navigation flows - + Map user interactions and navigation flows Route definitions and navigation Form submissions and validations @@ -57,31 +42,20 @@ State changes and UI updates Loading and error states - - -src -Route.*path=|router\.push|navigate\(|Link.*to= - - - - -src -onClick=|onSubmit=|onChange=|handleClick|handleSubmit - - - - -src -validate|validation|required|pattern=|minLength|maxLength - - ]]> + + Outline entry points and expected outcomes for each primary flow. + Summarize validation rules and failure states the user can encounter. + Record redirects and deep-link behavior relevant to the feature. + + + Flow diagrams or bullet sequences for main tasks. + Validation conditions and error messages. + Navigation transitions and guards. + - - Analyze how the system communicates with users - + Analyze how the system communicates with users Error messages and alerts Success notifications @@ -90,31 +64,19 @@ Confirmation dialogs Progress indicators - - -src -toast|notification|alert|message|error.*message|success.*message - - - - -src -loading|isLoading|pending|spinner|skeleton|placeholder - - - - -src -modal|dialog|confirm|popup|overlay - - ]]> + + Map message triggers to the user actions that cause them. + Capture severity, persistence, and dismissal behavior. + Note localization or accessibility considerations in messages. + + + Catalog of messages with purpose and conditions. + Loading/progress patterns and timeouts. + - - Check for accessibility features and compliance - + Check for accessibility features and compliance ARIA labels and roles Keyboard navigation support @@ -122,25 +84,17 @@ Focus management Color contrast considerations - - -src -aria-|role=|tabIndex|alt=|title=|accessibilityLabel - - - - -src -focus\(|blur\(|onFocus|onBlur|autoFocus|focusable - - ]]> + + Confirm interactive elements have clear focus and labels. + Describe keyboard-only navigation paths for core flows. + + + Accessibility gaps affecting task completion. + - - Analyze responsive design and mobile experience - + Analyze responsive design and mobile experience Breakpoint definitions Mobile-specific components @@ -148,230 +102,88 @@ Viewport configurations Media queries - - -src -@media|breakpoint|mobile|tablet|desktop|responsive - - - - -src -onTouch|swipe|gesture|tap|press - - ]]> + + Summarize layout changes across breakpoints that alter workflow. + Note touch targets and gestures required on mobile. + + + Table of key differences per breakpoint. + - - - Use semantic search to find conceptually related code when available. - - - Finding code by concept rather than keywords - Discovering implementations across different naming conventions - When pattern-based search isn't finding expected results - - - -user authentication login security JWT token validation - - - - -payment processing transaction billing invoice checkout - - ]]> - This is an optional tool - use when semantic understanding would help find related code that keyword search might miss - - - - Analyze entry points to understand feature flow. - + Understand feature entry points and control flow - Find main functions, controllers, or route handlers. - Trace execution flow. - Map decision branches. - Document input validation. + Identify main functions, controllers, or route handlers. + Trace execution and decision branches. + Document input validation and preconditions. - - - Start by exploring directory structure - - -src -false - - - - -src/controllers -true - - ]]> - - - - Search for specific patterns - - -src -(app\.(get|post|put|delete)|@(Get|Post|Put|Delete)|router\.(get|post|put|delete)) - - ]]> - - - - Read known entry points directly - - -src/app.ts - - - - -src/controllers/feature.controller.ts - - ]]> - - - - Use semantic search as an alternative discovery method - - -main entry point application startup initialization bootstrap - - ]]> - - + + Entry points list and short purpose statements. + Decision matrix or flow sketch. + - - Extract API specifications from code. - + Extract API specifications from code - - - HTTP method - - Route path - - Path/query parameters - - Request/response schemas - - Status codes + HTTP method and route path + Path/query parameters + Request/response schemas + Status codes and error bodies - - - Schema and input types - - Resolvers - - Return types - - Field arguments + Schema and input types + Resolvers and return types + Field arguments and constraints - - Map dependencies and integration points. - + Map dependencies and integration points - Import/require statements - package.json dependencies - External API calls - DB connections - Message queue integrations - Filesystem operations + Imports and module boundaries + Package and runtime dependencies + External API/SDK usage + DB connections and migrations + Messaging/queue/event streams + Filesystem or network side effects - - - Start with package.json to understand dependencies - - -package.json - - ]]> - - - - Follow import chains to map dependencies - - -src -^import\s+.*from\s+['"]([^'"]+)['"]|require\s*\(\s*['"]([^'"]+)['"]\s*\) - - ]]> - - - - Find external API integrations - - -src -(fetch|axios|http\.request|request\(|\.get\(|\.post\() - - ]]> - - + + Dependency graph summary and hot spots. + List of external integrations and auth methods. + - - Extract data models, schemas, and type definitions. - + Extract data models, schemas, and type definitions - - - interfaces, types, classes, enums - + - interfaces, types, classes, enums - - - Schema definitions, migration files, ORM models - + - Schema definitions, migration files, ORM models - - - JSON Schema, Joi/Yup/Zod schemas, validation decorators - + - JSON Schema, Joi/Yup/Zod schemas, validation decorators - - -src -^export\s+(interface|type|class|enum)\s+(\w+) - - - - -src/models -@(Entity|Table|Model)|class\s+\w+\s+extends\s+(Model|BaseEntity) - - ]]> + + Canonical definitions and field constraints. + Entity relationships and ownership. + - - Identify and document business rules. - + Identify and document business rules Complex conditionals Calculation functions @@ -380,79 +192,49 @@ type\s+(Query|Mutation|Subscription)\s*{[^}]+}|@(Query|Mutation|Resolver) Domain-specific constants and algorithms - Why logic exists (business need) - When logic applies (conditions) - What logic does (transformation) - Edge cases + Why the logic exists (business need) + When the logic applies (conditions) + What the logic does (transformation) + Edge cases and invariants Impact of changes - - Document error handling and recovery. - + Document error handling and recovery - try/catch blocks, error boundaries - Custom error classes - Error codes and messages + try/catch blocks and error boundaries + Custom error classes and codes Logging, fallbacks, retries, circuit breakers - - -src -try\s*{|catch\s*\(|throw\s+new|class\s+\w*Error\s+extends - - - - -src -ERROR_|_ERROR|ErrorCode|errorCode - - ]]> + + Error taxonomy and user-facing messages. + Recovery/rollback strategies and timeouts. + - - Identify security measures and vulnerabilities. - + Identify security measures and vulnerabilities - - - - JWT, sessions, OAuth, API keys - - - - - - RBAC, permission checks, ownership validation - - - - - - Encryption, hashing, sensitive data handling - - - - - - Sanitization, SQLi/XSS/CSRF prevention - - + JWT, sessions, OAuth, API keys + RBAC, permission checks, ownership validation + Encryption, hashing, sensitive data handling + Sanitization and injection prevention + + Threat surfaces and mitigations relevant to the feature. + - - Identify performance factors and optimization opportunities. - + Identify performance factors and optimization opportunities - DB query patterns (N+1) + Expensive loops/algorithms + DB query patterns (e.g., N+1) Caching strategies - Async usage - Batch processing - Resource pooling - Memory management - Algorithm complexity + Concurrency and async usage + Batching and resource pooling + Memory management and object lifetimes Time/space complexity @@ -464,51 +246,32 @@ type\s+(Query|Mutation|Subscription)\s*{[^}]+}|@(Query|Mutation|Resolver) - - Analyze test coverage. - + Assess test coverage at a useful granularity - __tests__, *.test.ts, *.spec.ts - Function coverage + Function-level coverage and edge cases - integration/, e2e/ - Workflow coverage + Workflow coverage and contract boundaries - api-tests/, *.api.test.ts - Endpoint coverage + Endpoint success/failure paths and schemas - - -src -\.(test|spec)\.(ts|js|tsx|jsx)$ -*.test.ts - - - - -src -(describe|it|test)\s*\(\s*['"`]([^'"`]+)['"`] - - ]]> + + List of critical behaviors missing tests. + - - Extract configuration options and their impacts. - + Extract configuration options and their impacts .env files, config files, CLI args, feature flags - Default values - Valid values - Behavior impact - Config dependencies + Default values and valid ranges + Behavioral impact of each option + Dependencies between options Security implications @@ -516,54 +279,49 @@ type\s+(Query|Mutation|Subscription)\s*{[^}]+}|@(Query|Mutation|Resolver) - - Map user workflows through the feature. - + Map user workflows through the feature - Identify entry points (UI, API, CLI). - Trace user actions. - Document decision points. - Map data transformations. - Identify outcomes. + Identify entry points (UI, API, CLI) + Trace user actions and decision points + Map data transformations + Identify outcomes and completion criteria - Flow diagrams, procedures, decision trees, state diagrams. + Flow diagrams, procedures, decision trees, state diagrams - - Document integration with other systems. - + Document integration with other systems - Sync API calls, async messaging, events, batch processing, streaming. + Sync API calls, async messaging, events, batch processing, streaming - Protocols, auth, error handling, data transforms, SLAs. + Protocols, auth, error handling, data transforms, SLAs + Summarize version constraints and compatibility - package.json, READMEs, migration guides, breaking changes docs. + package manifests, READMEs, migration guides, breaking changes docs - - -. -"engines":|"peerDependencies":|requires?\s+\w+\s+version|compatible\s+with - - ]]> + + Minimum/recommended versions and notable constraints. + + Track deprecations and migrations - @deprecated, TODO comments, legacy code markers. + Explicit deprecation notices and TODO markers + Legacy code paths and adapters - Deprecation date, removal timeline, migration path, alternatives. + Deprecation date and removal timeline + Migration path and alternatives @@ -571,17 +329,20 @@ type\s+(Query|Mutation|Subscription)\s*{[^}]+}|@(Query|Mutation|Resolver) - Public APIs documented. - Examples for complex features. - Error scenarios covered. - Config options explained. - Security addressed. + Public APIs documented with inputs/outputs and errors + Examples for complex features + Error scenarios covered with recovery guidance + Config options explained with defaults and impacts + Security considerations addressed - - Cyclomatic complexity, code duplication, test coverage, doc coverage, tech debt. + Cyclomatic complexity + Code duplication + Test coverage and gaps + Documentation coverage for user-visible behaviors + Known technical debt affecting UX diff --git a/.roo/rules-docs-extractor/6_communication_guidelines.xml b/.roo/rules-docs-extractor/4_communication_guidelines.xml similarity index 89% rename from .roo/rules-docs-extractor/6_communication_guidelines.xml rename to .roo/rules-docs-extractor/4_communication_guidelines.xml index 8691f2519cbd..43ec8479fc62 100644 --- a/.roo/rules-docs-extractor/6_communication_guidelines.xml +++ b/.roo/rules-docs-extractor/4_communication_guidelines.xml @@ -16,17 +16,6 @@ The user explicitly asks for options. - -Found multiple auth systems. Which to document? - -JWT-based system (src/auth/jwt/*) -OAuth2 integration (src/auth/oauth/*) -Basic auth middleware (src/middleware/basic-auth.ts) -All of them - - - ]]> @@ -62,7 +51,7 @@ - + - + @@ -116,7 +105,7 @@ See the full verification report for detailed corrections and suggestions. Always specify language for syntax highlighting (e.g., typescript, json, bash). Include file paths as comments where relevant. - ```typescript // src/auth/auth.service.ts export class AuthService { @@ -125,19 +114,19 @@ export class AuthService { } } ``` - ]]> + Use tables for structured data like configs. Include headers and align columns. Keep cell content brief. - | Variable | Type | Default | Description | |----------|------|---------|-------------| | `JWT_SECRET` | string | - | Secret key for JWT signing | | `JWT_EXPIRATION` | string | '15m' | Token expiration time | - ]]> + @@ -180,14 +169,14 @@ export class AuthService { - --- Feature: Authentication System Version: 2.1.0 Last Updated: 2024-01-15 Status: Stable --- - ]]> + @@ -208,16 +197,11 @@ Status: Stable Standard programming terms. Code snippets, implementation details. - + Instructional, step-by-step. Simple language, no jargon. Screenshots, real-world scenarios. - - Operational focus. - IT/DevOps terms. - CLI examples, configs. - @@ -229,7 +213,7 @@ Status: Stable Recommended next steps. - Feature extraction complete for the authentication system. **Extraction Report**: `EXTRACTION-authentication-system.md` @@ -252,9 +236,9 @@ Feature extraction complete for the authentication system. - Error messages need user-friendly translations The extraction report contains all details needed for comprehensive documentation. - ]]> + - Documentation verification complete for the authentication system. **Verification Report**: `VERIFICATION-authentication-system.md` @@ -271,7 +255,7 @@ Documentation verification complete for the authentication system. **Clarity Improvements**: 3 suggestions Please review the verification report for specific corrections needed. - ]]> + diff --git a/.roo/rules-docs-extractor/4_tool_usage_guide.xml b/.roo/rules-docs-extractor/4_tool_usage_guide.xml deleted file mode 100644 index 50499172730f..000000000000 --- a/.roo/rules-docs-extractor/4_tool_usage_guide.xml +++ /dev/null @@ -1,397 +0,0 @@ - - - Guidance on using tools for documentation extraction. - - - - - Use the most appropriate tools for the situation - - Start with what you know - file names, directory structure, or keywords - Use multiple discovery methods to build understanding - Adapt your approach based on the codebase structure - - - - - - Explore directory structure and find relevant files - - - Starting exploration of a feature area - - Understanding project organization - - Finding configuration or test files - - - - - Examine specific files in detail - - - Analyzing implementation details - - Understanding configuration - - Reading documentation or comments - - Read multiple related files together for better context - - - - Find specific patterns or text - - - Locating API endpoints - - Finding configuration usage - - Tracking down error handling - - Discovering cross-references - - - - - Get overview of code structure - - - Understanding module organization - - Identifying main components - - Finding test coverage - - - - - Semantic search when available - - - Finding conceptually related code - - Discovering implementations by functionality - - When keyword search isn't sufficient - - Optional - use when semantic understanding is needed - - - - - - Start from high-level structure and drill down - - List files in feature directory - Identify main entry points - Follow imports and dependencies - Examine implementation details - - - - - Use tests to understand expected behavior - - Find test files for the feature - Read test descriptions and scenarios - Trace back to implementation - Verify behavior matches tests - - - - - Start with configuration to understand setup - - Find configuration files - Identify feature flags and settings - Trace usage in code - Document impacts of each setting - - - - - Map external interfaces first - - Search for route definitions - Find API controllers or handlers - Trace to business logic - Document request/response flow - - - - - - - - Create extraction or verification report files. - Generates reports for documentation teams, not final documentation. - - - For extraction: EXTRACTION-[feature-name].md - - For verification: VERIFICATION-[feature-name].md - - - Use descriptive feature name in filename. - Include table of contents. - Use consistent Markdown formatting. - Include syntax-highlighted code examples. - - -EXTRACTION-authentication-system.md - -# Authentication System Documentation - -## Table of Contents -1. [Overview](#overview) -2. [Architecture](#architecture) -... - -## Overview -The authentication system provides secure user authentication using JWT tokens... - -... - - ]]> - - - - Clarify ambiguous requirements. - - Multiple features have similar names. - Documentation depth is unclear. - Audience priorities are undefined. - - - -Which authentication aspects should be the focus? - -The complete flow (JWT, sessions, OAuth). -Only JWT implementation and validation. -Only OAuth2 integration. -Password reset and recovery workflows. - - - ]]> - -What level of technical detail is needed? - -High-level overview for all audiences. -Detailed developer implementation. -API reference with code examples. -Full coverage for all audiences. - - - ]]> - - - - - - - - Find all files related to a feature using various methods. - - - - Start by exploring likely directories - -src -false - - - - -src/features/[feature-name] -true - - ]]> - - - - Search for feature-related patterns - - -src -feature-name|FeatureName - - - - -src -describe\(['"].*Feature.*['"]|test\(['"].*feature.*['"] -*.test.ts - - ]]> - - - - Find configuration files - - -config -true - - - - -. -feature.*config|settings.*feature -*.json - - ]]> - - - - Use semantic search if available and helpful - - -feature implementation main logic - - ]]> - This is optional - use when other methods aren't sufficient - - - - - - - Follow import chains to map dependencies. - - - Read main file. - Extract all imports. - Read each imported file. - Recursively analyze imports. - Build dependency graph. - - - -src/feature -import\s+(?:{[^}]+}|\*\s+as\s+\w+|\w+)\s+from\s+['"]([^'"]+)['"] - - - - -src/feature -require\(['"]([^'"]+)['"]\) - - ]]> - - - - - Extract API documentation from code. - - - Route definitions, request/response schemas, auth requirements, rate limiting, error responses. - - - - Find route files. - Extract route definitions. - Find controllers. - Analyze request validation. - Document response formats. - - - - - - - Use tests to document expected behavior. - - - Tests provide usage examples. - Test descriptions explain functionality. - Tests cover edge cases. - Tests document expected outputs. - - - -__tests__ -(describe|it|test)\(['"]([^'"]+)['"] - - - - -__tests__/feature.test.ts - - ]]> - - - - - - - .env.example - config/*.json - src/config/* - README.md (configuration section) - - - - - - - Custom error classes - Error code constants - Error message templates - HTTP status codes - - -src -class\s+\w*Error\s+extends|new Error\(|throw new|ERROR_CODE|HTTP_STATUS - - ]]> - - - - - Authentication methods - Authorization rules - Data encryption - Input validation - Rate limiting - - -src -@Authorized|requireAuth|checkPermission|encrypt|decrypt|sanitize|validate|rateLimit - - ]]> - - - - - - Organize output for navigation. - - - Clear hierarchy, consistent headings, ToC with links, cross-references. - - - - - Include relevant code examples. - - - Use syntax highlighting, show request/response, include error cases. - - - - - Suggest diagrams where helpful. - - - Architecture, sequence, data flow, state machine diagrams. - - - - - Include important metadata. - - - Version compatibility, last updated, status, performance, security. - - - - \ No newline at end of file diff --git a/.roo/rules-docs-extractor/5_complete_extraction_examples.xml b/.roo/rules-docs-extractor/5_complete_extraction_examples.xml deleted file mode 100644 index 8c644e2f03ad..000000000000 --- a/.roo/rules-docs-extractor/5_complete_extraction_examples.xml +++ /dev/null @@ -1,881 +0,0 @@ - - - Examples of both documentation extraction and verification workflows demonstrating flexible discovery methods and comprehensive UI/UX analysis. - - - - - Extract comprehensive documentation for a JWT-based authentication system, including technical implementation, UI/UX elements, and user workflows. - - - - - Initialize and discover feature using flexible methods - - -src -false - - ]]> - Look for auth-related directories like auth/, authentication/, or security/ - -src/auth -true - - ]]> - - - Auth controllers, services, middleware, models, and routes - - Login components and forms - - Session management UI - - - - - Analyze code structure and architecture - -src/auth - - ]]> - - - Identify main classes/functions - - Map authentication flow - - Find token generation/validation logic - - Locate UI components - - - - - Read core implementation files - - - - src/auth/auth.controller.ts - - - src/auth/auth.service.ts - - - src/auth/jwt.strategy.ts - - - src/auth/auth.guard.ts - - - src/models/user.model.ts - - - - ]]> - - - - UI/UX Analysis - Discover UI components - - -src/components -(Login|Auth|Session|Password).*\.(tsx?|jsx?) -*.tsx - - ]]> - - - - src/components/LoginForm.tsx - - - src/components/SessionManager.tsx - - - src/components/PasswordReset.tsx - - - - ]]> - - - - UI/UX Analysis - Map user interactions - -src/components -onClick|onSubmit|onChange|handleSubmit|validate - - ]]> - - - Form validation patterns - - User feedback mechanisms - - Error handling UI - - Loading states - - - - - UI/UX Analysis - Visual patterns and accessibility - -src -className=|style=|theme\.|aria-|role= -*.tsx - - ]]> - -src/styles -\.login|\.auth|\.session -*.css - - ]]> - - - - Extract API endpoints and configuration - -src/auth -@(Post|Get)\(['"]\/auth\/[^'"]+['"]|router\.(post|get)\(['"]\/auth\/[^'"]+['"] - - ]]> - -src -JWT_SECRET|JWT_EXPIRATION|AUTH_.*|process\.env\.\w*AUTH\w* - - ]]> - - - - Optional: Use semantic search for deeper insights - - -authentication error handling user feedback messages - - ]]> - Used when specific patterns don't capture all relevant error handling - - - - Create comprehensive extraction report - -EXTRACTION-authentication-system.md - -# Authentication System - Feature Extraction Report - -## Executive Summary -The authentication system is a JWT-based security implementation that handles user registration, login, session management, and access control. It provides a comprehensive user experience with visual feedback, accessibility features, and robust error handling. - -## UI/UX Analysis - -### User Interface Components - -#### 1. Login Page (`src/components/LoginForm.tsx`) -**Visual Layout:** -- Centered card design with shadow (400px width) -- Company logo at top -- Form fields with floating labels -- Primary blue theme (#1976d2) - -**Interactive Elements:** -- Email input field - - Real-time validation (regex: /^[^\s@]+@[^\s@]+\.[^\s@]+$/) - - Error state: Red border and helper text - - Success state: Green checkmark icon -- Password field - - Show/hide toggle button (eye icon) - - Minimum 8 characters validation - - Caps lock warning indicator -- "Remember me" checkbox with 30-day persistence -- "Forgot password?" link (underlined on hover) -- Submit button - - Disabled state: Gray background until valid input - - Loading state: Spinner replaces text - - Success state: Checkmark animation - -**User Feedback:** -- Loading overlay with spinner during authentication -- Error messages appear with slide-down animation -- Success toast notification (3s duration) -- Form shake animation on error - -#### 2. Registration Form (`src/components/RegisterForm.tsx`) -**Multi-Step Design:** -- Progress bar showing 3 steps -- Smooth slide transitions between steps -- Back/Next navigation buttons - -**Step 1 - Account Info:** -- Email field with async availability check -- Password field with strength meter (5 levels) -- Password confirmation with match validation - -**Step 2 - Personal Info:** -- First/Last name fields -- Optional phone with format mask -- Country dropdown with flag icons - -**Step 3 - Terms & Submit:** -- Terms of service scrollable text -- Privacy policy link (opens modal) -- Checkbox required for submission -- Review summary before final submit - -**Visual Feedback:** -- Field validation on blur -- Progress saved in localStorage -- Success confetti animation -- Auto-redirect countdown (5s) - -#### 3. Session Management (`src/components/SessionManager.tsx`) -**Device List UI:** -- Card-based layout for each session -- Device icons (FontAwesome) - - fa-mobile for mobile - - fa-desktop for desktop - - fa-tablet for tablet -- Information displayed: - - Device name and browser - - IP address (partially masked) - - Last active (relative time) - - Location (city, country) - -**Interactive Features:** -- Current device highlighted with blue border -- Hover state shows "Revoke" button -- Confirmation modal with device details -- Bulk selection with checkboxes -- "Revoke All" with double confirmation - -### User Experience Elements - -#### Visual Patterns -**Theme System:** -```css ---primary-color: #1976d2; ---error-color: #d32f2f; ---success-color: #388e3c; ---warning-color: #f57c00; ---text-primary: rgba(0, 0, 0, 0.87); ---text-secondary: rgba(0, 0, 0, 0.6); -``` - -**Animations:** -- Page transitions: 300ms ease-in-out -- Button hover: scale(1.02) -- Error shake: 0.5s horizontal -- Success checkmark: SVG path animation -- Loading spinner: 1s rotation - -**Responsive Breakpoints:** -- Mobile: < 768px (single column) -- Tablet: 768px - 1024px -- Desktop: > 1024px - -#### Accessibility Features -**Keyboard Navigation:** -- Tab order follows visual flow -- Enter key submits forms -- Escape closes modals -- Arrow keys in dropdowns - -**Screen Reader Support:** -- ARIA labels on all inputs -- Live regions for errors -- Role attributes for custom components -- Descriptive button text - -**Visual Accessibility:** -- 4.5:1 contrast ratio minimum -- Focus indicators (2px outline) -- Error icons for colorblind users -- Scalable fonts (rem units) - -### User Workflows - -#### 1. First-Time Registration -``` -Start → Landing Page → "Get Started" CTA - ↓ -Registration Form (Step 1) - → Email validation (async) - → Password strength check - → Real-time feedback - ↓ -Personal Info (Step 2) - → Optional fields clearly marked - → Format validation - ↓ -Terms Agreement (Step 3) - → Must scroll to enable checkbox - → Review summary - ↓ -Submit → Loading → Success - → Confetti animation - → Welcome email sent - → Auto-redirect (5s) - ↓ -Dashboard (First-time tour) -``` - -#### 2. Returning User Login -``` -Start → Login Page - ↓ -Enter Credentials - → Email autocomplete - → Password manager integration - → "Remember me" option - ↓ -Submit → Loading (avg 1.2s) - ↓ -Success → Dashboard - OR -Error → Inline feedback - → Retry with guidance - → "Forgot password?" option -``` - -#### 3. Password Reset Flow -``` -Login Page → "Forgot password?" - ↓ -Modal Dialog - → Email input - → Captcha (if multiple attempts) - ↓ -Submit → "Check email" message - ↓ -Email Received (< 1 min) - → Secure link (1hr expiry) - ↓ -Reset Page - → New password requirements shown - → Strength meter - → Confirmation field - ↓ -Submit → Success → Login redirect -``` - -## Technical Details - -### Core Components -1. **AuthController** (`src/auth/auth.controller.ts`) - - REST endpoints with validation decorators - - Rate limiting middleware - - CORS configuration - -2. **AuthService** (`src/auth/auth.service.ts`) - - JWT token generation/validation - - Bcrypt password hashing - - Session management logic - -3. **Security Implementation** - - JWT RS256 algorithm - - Refresh token rotation - - CSRF double-submit cookies - - XSS protection headers - -### API Endpoints -| Method | Endpoint | Description | Rate Limit | -|--------|----------|-------------|------------| -| POST | /auth/register | New user registration | 3/hour | -| POST | /auth/login | User authentication | 5/min | -| POST | /auth/refresh | Token refresh | 10/min | -| POST | /auth/logout | Session termination | None | -| GET | /auth/profile | Current user data | None | -| POST | /auth/reset-password | Password reset | 3/hour | - -### Configuration -```env -# Required -JWT_SECRET=minimum-32-character-secret -DATABASE_URL=postgresql://... - -# Optional with defaults -JWT_EXPIRATION=15m -REFRESH_TOKEN_EXPIRATION=7d -BCRYPT_ROUNDS=10 -SESSION_MAX_AGE=30d -MAX_SESSIONS_PER_USER=5 -``` - -## Non-Technical Information - -### Business Rules -1. **Account Creation** - - Unique email required - - Password: 8+ chars, mixed case, number, special - - Email verification within 24 hours - - Terms acceptance mandatory - -2. **Session Management** - - Max 5 concurrent sessions - - Idle timeout: 30 minutes - - Absolute timeout: 7 days - - Device trust for 30 days - -3. **Security Policies** - - Account lockout: 5 failed attempts (15 min) - - Password history: Last 3 not reusable - - 2FA optional but recommended - - Suspicious login notifications - -### Common User Scenarios - -#### Mobile Experience -- Touch-optimized buttons (44px min) -- Biometric login (Face ID/Touch ID) -- Simplified navigation menu -- Offline detection with retry -- Push notification for new sessions - -#### Error Recovery -- Network timeout: Auto-retry with backoff -- Session expired: Smooth re-login flow -- Form errors: Contextual help text -- Server errors: Friendly messages with support link - -### Performance Metrics -- Login response: 200ms (p50), 500ms (p95) -- Page load: 1.2s (3G), 400ms (4G) -- Token validation: < 10ms -- Session check: < 50ms - -## Documentation Recommendations - -### Critical Areas for User Documentation -1. **Getting Started Guide** - - Screenshots of each registration step - - Common email provider settings - - Password manager setup - -2. **Troubleshooting Section** - - "Why can't I log in?" flowchart - - Browser compatibility matrix - - Cookie/JavaScript requirements - -3. **Security Best Practices** - - How to spot phishing attempts - - Importance of unique passwords - - When to revoke sessions - -### Developer Integration Guide -1. **API Authentication** - - Bearer token format - - Refresh token flow diagram - - Error response examples - -2. **SDK Examples** - - JavaScript/TypeScript - - Python - - Mobile (iOS/Android) - -## Integration Points -- Email service for password reset and notifications -- Session storage (Redis optional, in-memory default) -- Rate limiting middleware -- CORS configuration for cross-origin requests -- Logging service for audit trails - -## Summary for Documentation Team -This extraction report provides comprehensive details about the authentication system's current implementation. The system offers a complete user experience with visual feedback, accessibility features, and robust security measures. Key areas for user documentation include the multi-step registration process, session management features, and security policies. The technical implementation uses industry-standard JWT tokens with proper security measures. - -354 - - ]]> - - - - - Use flexible discovery methods - directory exploration and pattern search are primary tools - Comprehensive UI/UX analysis is essential for complete documentation - Document visual elements, interactions, and user feedback mechanisms - Include accessibility and responsive design considerations - Semantic search (codebase_search) is optional for deeper insights when needed - Organize findings to support documentation team's work - - - - - - Verify user-provided documentation about authentication UI/UX against the actual implementation. - - - - - User provides documentation to verify - - "Please verify our login documentation: - - 'The login form provides a seamless experience with instant validation. Users see a green checkmark when their email is valid. The password field includes a strength indicator. After 3 failed attempts, users must wait 5 minutes before trying again.'" - - - - - Analyze the documentation claims - - Claims to verify: - - Instant email validation with green checkmark - - Password strength indicator on login - - 3 failed attempts triggers 5-minute wait - - - - - Find login UI components using directory exploration - -src/components -false - - ]]> - -src/components -Login|SignIn|Auth.*Form -*.tsx - - ]]> - - - - Examine login form implementation - - - - src/components/LoginForm.tsx - - - src/components/LoginForm.css - - - - ]]> - - - Email validation exists but shows red X, not green checkmark - - No password strength indicator on login form (only on registration) - - Account lockout is after 5 attempts, not 3 - - Lockout duration is 15 minutes, not 5 - - - - - Verify validation behavior - -src/components -validateEmail|emailValid|checkmark|strength.*indicator - - ]]> - -src/auth -failed.*attempts|lockout|rate.*limit - - ]]> - - - - Create verification report - -VERIFICATION-login-documentation.md - -# Login Documentation - Verification Report - -## Overall Assessment: Needs Significant Updates - -## Summary -The login documentation contains several inaccuracies about the UI/UX implementation that could confuse users and lead to poor user experience. - -## Critical Inaccuracies - -### 1. Email Validation Feedback -**Documentation States**: "Users see a green checkmark when their email is valid" -**Actual Implementation**: Red X icon for invalid emails, no positive feedback -- Location: `src/components/LoginForm.tsx:45-52` -- Current behavior: Only shows error states -- Missing: Success indicator implementation -- **Impact**: Users don't get positive reinforcement for correct input - -### 2. Password Strength Indicator -**Documentation States**: "The password field includes a strength indicator" -**Actual Implementation**: No strength indicator on login form -- Location: Checked `src/components/LoginForm.tsx` -- Strength indicator only exists in `RegisterForm.tsx` -- Login form has basic password field only -- **Impact**: Sets incorrect user expectations - -### 3. Failed Login Attempts -**Documentation States**: "After 3 failed attempts, users must wait 5 minutes" -**Actual Implementation**: 5 attempts, 15-minute lockout -- Location: `src/auth/services/auth.service.ts:234` -- Code: `MAX_LOGIN_ATTEMPTS = 5` -- Code: `LOCKOUT_DURATION = 15 * 60 * 1000 // 15 minutes` -- **Impact**: Users may be confused about actual security policy - -## UI/UX Elements Found But Not Documented - -### 1. Loading States -- Spinner overlay during authentication -- Button disabled state during submission -- These improve perceived performance - -### 2. Remember Me Feature -- 30-day persistent session option -- Stored in secure cookie -- Not mentioned in documentation - -### 3. Caps Lock Warning -- Visual indicator when caps lock is on -- Helps prevent login failures -- Important accessibility feature - -## Recommendations - -### Immediate Corrections Needed -1. **Email Validation**: - ``` - CORRECT: "The email field shows a red error icon for invalid formats. Valid emails are accepted without visual confirmation." - ``` - -2. **Password Features**: - ``` - CORRECT: "The login form has a standard password field with show/hide toggle. Password strength indicators are only shown during registration." - ``` - -3. **Security Policy**: - ``` - CORRECT: "After 5 failed login attempts, accounts are temporarily locked for 15 minutes to prevent brute force attacks." - ``` - -### Suggested Additions -1. Document the loading states and visual feedback -2. Explain the "Remember Me" functionality -3. Mention the Caps Lock warning feature -4. Add screenshots of actual UI states - -## Technical References -- Login Form Component: `src/components/LoginForm.tsx` -- Styles: `src/components/LoginForm.css` -- Auth Service: `src/auth/services/auth.service.ts` -- Rate Limiting: `src/middleware/rateLimiter.ts` - -## Visual Discrepancies -- Documentation implies more visual feedback than implemented -- Color scheme in docs doesn't match actual theme -- Missing documentation for error message styling - -## Conclusion -The documentation needs updates to accurately reflect the current login experience. The actual implementation is more security-focused (5 attempts, 15-min lockout) but less visually rich (no success indicators) than documented. - -95 - - ]]> - - - - - Always verify UI/UX claims against actual component implementation - Check both visual elements and behavioral logic - Look for undocumented features that users might expect - Provide specific corrections with code references - Consider the impact of inaccuracies on user experience - - - - - - Extract comprehensive API documentation including endpoints, request/response formats, and error handling. - - - - - Discover API structure using flexible methods - - -src -false - - ]]> - -src/api -true - - ]]> - - - - Find all API routes using pattern search - -src -(app|router)\.(get|post|put|patch|delete|all)\s*\(\s*['"`]([^'"`]+)['"`] - - ]]> - - - - Extract request validation schemas - -src -@(Body|Query|Param|Headers)\(|joi\.object|yup\.object|zod\.object - - ]]> - - - - Analyze error handling and responses - -src -@ApiResponse|response\.status\(|res\.status\(|throw new.*Error - - ]]> - - - - Optional: Semantic search for middleware and auth - - -API middleware authentication authorization guards - - ]]> - - - - Generate API extraction report - - - Complete endpoint inventory with methods and paths - - Request/response schemas with examples - - Authentication requirements per endpoint - - Rate limiting and throttling rules - - Error response formats and codes - - API versioning strategy - - - - - - - - Document a React component library including props, styling, accessibility, and usage patterns. - - - - - Discover component structure - -src/components -true - - ]]> - - - - Analyze component interfaces and props - -src/components -interface\s+\w+Props|type\s+\w+Props|export\s+(default\s+)?function|export\s+const -*.tsx - - ]]> - - - - Extract styling and theme usage - -src/components -styled\.|makeStyles|className=|sx=|css= - - ]]> - - - - Document accessibility features - -src/components -aria-|role=|tabIndex|alt=|htmlFor= - - ]]> - - - - Find usage examples and stories - -src -\.stories\.|\.story\.|examples?/|demo/ -*.tsx - - ]]> - - - - Create component library report - - - Component hierarchy and relationships - - Props documentation with types and defaults - - Styling system and customization options - - Accessibility compliance checklist - - Interactive examples and code snippets - - Best practices and anti-patterns - - Browser compatibility notes - - - - - - - - Use the most appropriate discovery method - - Start with directory exploration for well-organized codebases - Use pattern search for specific syntax or naming conventions - Apply file-based search when you know exact locations - Reserve semantic search for complex conceptual queries - - - - - Ensure complete UI/UX documentation - - Visual design and layout - Interactive elements and states - User feedback mechanisms - Accessibility features - Responsive behavior - Animation and transitions - Error states and recovery - Loading and progress indicators - - - - - Verify all aspects of documentation claims - - Technical accuracy of code examples - UI element descriptions match implementation - User workflows reflect actual behavior - Configuration values are current - Error messages match code - Performance claims are realistic - - - - \ No newline at end of file diff --git a/.roo/rules-docs-extractor/7_user_friendly_examples.xml b/.roo/rules-docs-extractor/7_user_friendly_examples.xml deleted file mode 100644 index 6b94e88de609..000000000000 --- a/.roo/rules-docs-extractor/7_user_friendly_examples.xml +++ /dev/null @@ -1,218 +0,0 @@ - - - Examples for creating user-focused, practical documentation. - - - - - The concurrent file read feature uses parallel processing. - Read multiple files at once, reducing interruptions. - - - - This improves efficiency. - Instead of approving 10 file reads one-by-one, approve them all at once. - - - - The feature uses a thread pool with configurable concurrency limits. - Roo reads up to 100 files at once (changeable in settings). - - - - Users must configure the concurrent file read limit parameter. - Adjust how many files Roo reads at once in settings. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The system imposes a hard limit of 100 concurrent operations. - Roo handles up to 100 files at once. - - - - Error: Maximum concurrency threshold exceeded. - Too many files requested. Lower the file limit in settings. - - - - Reduces API call overhead through request batching. - Get answers faster by reading all needed files at once. - - - - - - Error: ⚠️ - Tip: 💡 - Note: 📝 - Security: 🔒 - - - - For emphasis - For settings, file paths, or commands - For callouts or warnings - - - - - - Concurrent File Reads Doc - - - - - Does it start with benefits? - Are technical terms avoided? - Is the tone direct? - Are there practical examples? - Are sections short and scannable? - Does it answer user questions? - Is help accessible? - - \ No newline at end of file diff --git a/.roomodes b/.roomodes index 17ec5fce2309..01f6ed450506 100644 --- a/.roomodes +++ b/.roomodes @@ -94,19 +94,19 @@ customModes: You are Roo, a documentation analysis specialist with two primary functions: 1. Extract comprehensive technical and non-technical details about features to provide to documentation teams 2. Verify existing documentation for factual accuracy against the codebase - + For extraction: You analyze codebases to gather all relevant information about how features work, including technical implementation details, user workflows, configuration options, and use cases. You organize this information clearly for documentation teams to use. - + For verification: You review provided documentation against the actual codebase implementation, checking for technical accuracy, completeness, and clarity. You identify inaccuracies, missing information, and provide specific corrections. - + You do not generate final user-facing documentation, but rather provide detailed analysis and verification reports. - whenToUse: Use this mode when you need to either extract detailed information about a feature for documentation teams, or verify existing documentation for accuracy against the codebase. + whenToUse: Use this mode only for two tasks; 1) confirm the accuracy of documentation provided to the agent against the codebase, and 2) generate source material for user-facing docs about a requested feature or aspect of the codebase. description: Extract feature details or verify documentation accuracy. groups: - read - - edit - - fileRegex: (DOCS-TEMP-.*\.md$|\.roo/docs-extractor/.*\.md$) - description: Temporary documentation extraction files only + - fileRegex: (EXTRACTION-.*\.md$|VERIFICATION-.*\.md$|DOCS-TEMP-.*\.md$|\.roo/docs-extractor/.*\.md$) + description: Extraction/Verification report files only (source-material), plus legacy DOCS-TEMP - command - mcp - slug: pr-fixer