2eae6ad21a
The plugin had hardcoded references to 'CORA' (Every's internal project) throughout the documentation workflow, making it project-specific rather than generic. This affected users trying to use the plugin on non-CORA projects. Changes: - Replace 'cora-critical-patterns.md' with 'critical-patterns.md' - Replace 'Which CORA module' with 'Which module or component' - Replace 'CORA-Specific Resources' with 'Project-Specific Resources' - Replace 'CORA-MODULES.md' with 'modules documentation' - Replace 'CORA system' with 'System-wide' in templates - Update cora-test-reviewer description to be generic Files modified: - learnings-researcher.md: Fixed critical patterns file reference - compound-docs/SKILL.md: Removed module and filename hardcoding - compound-docs/assets/*.md: Generalized template references - workflows/compound.md: Changed 'CORA schema' to 'solution schema' - workflows/work.md: Made test reviewer description generic This makes the plugin truly project-agnostic as advertised.
3.1 KiB
3.1 KiB
module, date, problem_type, component, symptoms, root_cause, rails_version, resolution_type, severity, tags
| module | date | problem_type | component | symptoms | root_cause | rails_version | resolution_type | severity | tags | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
Troubleshooting: [Clear Problem Title]
Problem
[1-2 sentence clear description of the issue and what the user experienced]
Environment
- Module: [Name or "System-wide"]
- Rails Version: [e.g., 7.1.2]
- Affected Component: [e.g., "Email Processing model", "Brief System service", "Authentication controller"]
- Date: [YYYY-MM-DD when this was solved]
Symptoms
- [Observable symptom 1 - what the user saw/experienced]
- [Observable symptom 2 - error messages, visual issues, unexpected behavior]
- [Continue as needed - be specific]
What Didn't Work
Attempted Solution 1: [Description of what was tried]
- Why it failed: [Technical reason this didn't solve the problem]
Attempted Solution 2: [Description of second attempt]
- Why it failed: [Technical reason]
[Continue for all significant attempts that DIDN'T work]
[If nothing else was attempted first, write:] Direct solution: The problem was identified and fixed on the first attempt.
Solution
[The actual fix that worked - provide specific details]
Code changes (if applicable):
# Before (broken):
[Show the problematic code]
# After (fixed):
[Show the corrected code with explanation]
Database migration (if applicable):
# Migration change:
[Show what was changed in the migration]
Commands run (if applicable):
# Steps taken to fix:
[Commands or actions]
Why This Works
[Technical explanation of:]
- What was the ROOT CAUSE of the problem?
- Why does the solution address this root cause?
- What was the underlying issue (API misuse, configuration error, Rails version issue, etc.)?
[Be detailed enough that future developers understand the "why", not just the "what"]
Prevention
[How to avoid this problem in future development:]
- [Specific coding practice, check, or pattern to follow]
- [What to watch out for]
- [How to catch this early]
Related Issues
[If any similar problems exist in docs/solutions/, link to them:]
- See also: another-related-issue.md
- Similar to: related-problem.md
[If no related issues, write:] No related issues documented yet.