141 lines
3.3 KiB
Markdown
141 lines
3.3 KiB
Markdown
# 📚 Documentation Index
|
|
|
|
**Last Updated:** 2025-01-20
|
|
**Purpose:** Centralized documentation for Cognitive Prism Automation Testing
|
|
|
|
---
|
|
|
|
## 📁 **Directory Structure**
|
|
|
|
```
|
|
documentation/
|
|
├── ui-team-requirements/ # Requirements and specifications for UI team
|
|
├── automation-status/ # Current status and improvements for automation team
|
|
├── debug-tools/ # Debugging guides and approaches
|
|
├── verification-reports/ # Verification and testing reports
|
|
└── quick-references/ # Quick reference guides
|
|
```
|
|
|
|
---
|
|
|
|
## 📋 **Documentation by Category**
|
|
|
|
### **🎨 UI Team Requirements** (`ui-team-requirements/`)
|
|
|
|
Documents for the UI development team:
|
|
|
|
- **`UI_TEAM_DATA_TESTID_REQUIREMENTS.md`**
|
|
- Complete data-testid requirements for Profile Editor
|
|
- All missing attributes documented
|
|
- Implementation guidelines
|
|
|
|
- **`UI_TEAM_MANDATORY_RESET_DATA_TESTID.md`**
|
|
- Missing data-testid attributes for Password Reset Modal
|
|
- 14 required attributes with line numbers
|
|
- Priority levels (Critical/Important/Optional)
|
|
|
|
- **`UI_TEAM_QUICK_REFERENCE.md`**
|
|
- Quick reference for data-testid naming patterns
|
|
- Examples and best practices
|
|
- Format guidelines
|
|
|
|
---
|
|
|
|
### **🤖 Automation Status** (`automation-status/`)
|
|
|
|
Current status and improvements for automation team:
|
|
|
|
- **`MANDATORY_RESET_FLOW_STATUS.md`**
|
|
- Current status of password reset flow
|
|
- What's working vs. what needs UI updates
|
|
- Action plan and next steps
|
|
|
|
- **`PASSWORD_RESET_IMPROVEMENTS.md`**
|
|
- Detailed improvements made to password reset logic
|
|
- 10-step robust flow implementation
|
|
- Performance metrics
|
|
|
|
- **`PASSWORD_RESET_FIX_SUMMARY.md`**
|
|
- Summary of password reset fixes
|
|
- Issues identified and resolved
|
|
- Current status
|
|
|
|
- **`LOCATOR_UPDATE_SUMMARY.md`**
|
|
- Summary of locator updates from XPath to data-testid
|
|
- Migration status
|
|
- Verification results
|
|
|
|
---
|
|
|
|
### **🔧 Debug Tools** (`debug-tools/`)
|
|
|
|
Debugging guides and systematic approaches:
|
|
|
|
- **`WORLD_CLASS_DEBUG_APPROACH.md`**
|
|
- Systematic debug approach
|
|
- DOM Inspector tool documentation
|
|
- Best practices for debugging
|
|
- Time-saving strategies
|
|
|
|
---
|
|
|
|
### **✅ Verification Reports** (`verification-reports/`)
|
|
|
|
Verification and testing reports:
|
|
|
|
- **`FINAL_VERIFICATION_SUMMARY.md`**
|
|
- Final verification summary
|
|
- 100% completion status
|
|
- Ready for production confirmation
|
|
|
|
---
|
|
|
|
### **📖 Quick References** (`quick-references/`)
|
|
|
|
Quick reference guides:
|
|
|
|
- **`QUICK_REFERENCE_MANDATORY_RESET.md`**
|
|
- Quick reference for Mandatory Password Reset data-testid
|
|
- Priority levels
|
|
- Example implementations
|
|
|
|
---
|
|
|
|
## 🎯 **Quick Navigation**
|
|
|
|
### **For UI Team:**
|
|
→ See `ui-team-requirements/` folder
|
|
|
|
### **For Automation Team:**
|
|
→ See `automation-status/` folder
|
|
|
|
### **For Debugging:**
|
|
→ See `debug-tools/` folder
|
|
|
|
### **For Verification:**
|
|
→ See `verification-reports/` folder
|
|
|
|
---
|
|
|
|
## 📝 **Documentation Standards**
|
|
|
|
- All documentation uses Markdown format
|
|
- Files are organized by purpose and audience
|
|
- Clear naming conventions
|
|
- Regular updates maintained
|
|
|
|
---
|
|
|
|
## 🔄 **Maintenance**
|
|
|
|
- Update documentation when making changes
|
|
- Keep structure clean and organized
|
|
- Add new documents to appropriate folders
|
|
- Update this README when adding new categories
|
|
|
|
---
|
|
|
|
**Project Root:** Keep clean - all documentation in `documentation/` folder
|
|
|
|
|