mirror of
https://github.com/pacnpal/thrillwiki_laravel.git
synced 2025-12-23 05:31:14 -05:00
feat: Implement rides management with CRUD functionality
- Added rides index view with search and filter options. - Created rides show view to display ride details. - Implemented API routes for rides. - Developed authentication routes for user registration, login, and email verification. - Created tests for authentication, email verification, password reset, and user profile management. - Added feature tests for rides and operators, including creation, updating, deletion, and searching. - Implemented soft deletes and caching for rides and operators. - Enhanced manufacturer and operator model tests for various functionalities.
This commit is contained in:
130
memory-bank/instructions/MasterDocumentationUpdate.md
Normal file
130
memory-bank/instructions/MasterDocumentationUpdate.md
Normal file
@@ -0,0 +1,130 @@
|
||||
# Master.md Documentation Update Instructions
|
||||
|
||||
## Purpose
|
||||
This document provides instructions for maintaining the `master.md` file as the primary project documentation.
|
||||
|
||||
## Core Instruction
|
||||
**When implementing features, making architectural changes, or completing significant development work, always update `master.md` to reflect the current project state.**
|
||||
|
||||
## Update Triggers
|
||||
The `master.md` file should be updated when:
|
||||
|
||||
### Major Changes
|
||||
- ✅ New models or core components implemented
|
||||
- ✅ New Livewire components created
|
||||
- ✅ New features completed and tested
|
||||
- ✅ Architecture decisions made
|
||||
- ✅ Technology stack changes
|
||||
- ✅ Database schema modifications
|
||||
|
||||
### Documentation Events
|
||||
- ✅ Project milestones reached
|
||||
- ✅ Feature sets completed
|
||||
- ✅ Development phase transitions
|
||||
- ✅ Implementation status changes
|
||||
- ✅ New dependencies added
|
||||
|
||||
### Routine Updates
|
||||
- ✅ Component inventories change
|
||||
- ✅ File structure modifications
|
||||
- ✅ Development priorities shift
|
||||
- ✅ Setup instructions change
|
||||
|
||||
## What to Update in Master.md
|
||||
|
||||
### Implementation Status
|
||||
- Mark completed features with ✅
|
||||
- Update component and model listings
|
||||
- Add file links for new implementations
|
||||
- Document current development focus
|
||||
|
||||
### Technical Documentation
|
||||
- Update technology stack information
|
||||
- Modify setup and installation instructions
|
||||
- Add new configuration requirements
|
||||
- Document performance considerations
|
||||
|
||||
### Project Progress
|
||||
- Update development milestones
|
||||
- Modify next priority listings
|
||||
- Add new planned features
|
||||
- Document any architectural changes
|
||||
|
||||
## Update Process
|
||||
|
||||
1. **Before Major Work**: Review current master.md status
|
||||
2. **During Development**: Note changes that will require documentation
|
||||
3. **After Completion**: Update master.md immediately
|
||||
4. **Memory Bank Update**: Document the master.md changes in activeContext.md
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Content Organization
|
||||
- Maintain clear section structure
|
||||
- Use consistent formatting and links
|
||||
- Keep technical details accurate and current
|
||||
- Provide context for architectural decisions
|
||||
|
||||
### File Links
|
||||
- Link to actual implementation files
|
||||
- Use relative paths for consistency
|
||||
- Verify links work correctly
|
||||
- Update when files are moved or renamed
|
||||
|
||||
### Status Tracking
|
||||
- Use ✅ for completed features
|
||||
- Use 🔄 for in-progress work
|
||||
- Use ❌ for deprecated/removed features
|
||||
- Mark planned features clearly
|
||||
|
||||
## Integration with Memory Bank
|
||||
|
||||
### ActiveContext Updates
|
||||
When updating master.md, also update:
|
||||
- `memory-bank/activeContext.md` - Document the documentation changes
|
||||
- `memory-bank/progress.md` - Record the work completed
|
||||
- `memory-bank/decisionLog.md` - If architectural decisions were made
|
||||
|
||||
### Documentation Consistency
|
||||
Ensure master.md updates align with:
|
||||
- Memory Bank feature documentation
|
||||
- Component-specific documentation files
|
||||
- Model documentation in memory-bank/models/
|
||||
- Service documentation in memory-bank/services/
|
||||
|
||||
## Template Sections for Updates
|
||||
|
||||
### New Feature Documentation
|
||||
```markdown
|
||||
### ✅ [Feature Name]
|
||||
- **Status**: Implemented
|
||||
- **Components**: [List components with links]
|
||||
- **Models**: [List models with links]
|
||||
- **Key Files**: [List key implementation files]
|
||||
- **Next Steps**: [What comes next for this feature]
|
||||
```
|
||||
|
||||
### Technology Stack Updates
|
||||
```markdown
|
||||
### [Technology/Tool Name]
|
||||
- **Purpose**: [What it's used for]
|
||||
- **Version**: [Version being used]
|
||||
- **Configuration**: [Key configuration notes]
|
||||
- **Integration**: [How it integrates with existing stack]
|
||||
```
|
||||
|
||||
## Maintenance Schedule
|
||||
|
||||
### Immediate Updates
|
||||
- After completing major features
|
||||
- After architectural changes
|
||||
- After dependency changes
|
||||
|
||||
### Regular Review
|
||||
- Weekly progress updates
|
||||
- Monthly comprehensive review
|
||||
- Before project handoffs or milestones
|
||||
|
||||
---
|
||||
|
||||
**Remember**: The master.md file is often the first document new developers and stakeholders read. Keep it accurate, comprehensive, and current.
|
||||
Reference in New Issue
Block a user