-
-
Notifications
You must be signed in to change notification settings - Fork 34
Readme
Saros Industries edited this page Jun 28, 2025
·
1 revision
This directory contains the complete GitHub Wiki documentation for the CursorRIPERβ¦Ξ£ framework.
Wiki/
βββ Home.md # Main wiki landing page
βββ Getting-Started/ # Quick start guides for new users
βββ Core-Concepts/ # Framework fundamentals
βββ Features/ # Detailed feature documentation
βββ Guides/ # Step-by-step tutorials
βββ Reference/ # Complete reference documentation
βββ Advanced/ # Optional integrations (MCP, BMAD)
βββ Troubleshooting/ # Help and support
To deploy this wiki to GitHub:
- Navigate to your repository on GitHub
- Go to the Wiki tab
- Create pages matching the structure here
- Copy the content from each .md file
Alternatively, you can use the GitHub Wiki git repository:
git clone https://github.com/YOUR_USERNAME/CursorRIPER.sigma.wiki.git
# Copy all files from this directory
git add .
git commit -m "Add complete wiki documentation"
git push- Each section has its own
_Sidebar.mdfor navigation - Cross-links use relative paths for wiki compatibility
- Images reference the main repository's
/res/folder - Keep the Home.md updated with major changes
Last Updated: 2025-06-28
- ποΈ Framework Overview
- π RIPER Modes
- πΎ Memory System
- π£ Symbolic Notation
- π Phase Management
- π‘οΈ Code Protection
- π Context References
- π Permission System
- π Cross-References
- πΎ Backup System
- π Mode Transitions
- πΎ Memory Management
- π‘οΈ Protection Workflow
- π Context Management
- π₯ Team Collaboration
- π£ Symbol Reference
- β¨οΈ Command Reference
- π Mode Reference
- π Permission Matrix
- π API Reference
- π Overview
- π GitHub Integration
- π Web Search
- π Browser Automation
- π³ Docker Integration
-
Installation Issues
- Node.js Version Compatibility
- Package Installation Failures
- Framework Dependencies Missing
- Database Connection Issues
- Port Conflicts
- Environment Setup Issues
- Build and Development Issues
- Framework CLI Issues
-
Configuration & Runtime Issues
- Framework Configuration Problems
- Runtime Performance Issues
- Module Loading and Plugin Issues
- Database and Storage Issues
- Memory Leaks and High Memory Usage
- High CPU Usage
-
BMAD Module Issues
- BMAD Module Initialization Problems
- Business Model Canvas Issues
- Stakeholder Management Issues
- Analytics and Reporting Issues
- Performance Optimization
-
Database & API Issues
- Database Connection Problems
- Database Migration Issues
- API Performance and Reliability Issues
- Data Consistency Issues
- Transaction Problems
-
Performance & Memory Issues
- Memory Management
- CPU Optimization
- Database Query Performance
- Caching Issues
- Resource Monitoring
-
Security & Authentication Issues
- Authentication Failures
- Authorization Problems
- JWT Token Issues
- Session Management
- CORS and Security Headers
- SSL/TLS Configuration
-
Deployment & Production Issues
- Production Deployment Failures
- Environment Configuration
- Load Balancing Issues
- Monitoring and Logging
- Backup and Recovery
When reporting issues, please include:
- Framework version (
npm list @cursoriper/core) - Node.js version (
node --version) - Operating system and version
- Error messages and stack traces
- Steps to reproduce the issue
- Configuration files (sanitized)
- Recent changes or deployments
- Technical Support: support@cursoriper.com
- Documentation: https://docs.cursoriper.com
- Community Forum: https://community.cursoriper.com