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.
66 lines
3.0 KiB
Markdown
66 lines
3.0 KiB
Markdown
# YAML Frontmatter Schema
|
|
|
|
**See `.claude/skills/codify-docs/schema.yaml` for the complete schema specification.**
|
|
|
|
## Required Fields
|
|
|
|
- **module** (string): Module name (e.g., "EmailProcessing") or "System" for system-wide issues
|
|
- **date** (string): ISO 8601 date (YYYY-MM-DD)
|
|
- **problem_type** (enum): One of [build_error, test_failure, runtime_error, performance_issue, database_issue, security_issue, ui_bug, integration_issue, logic_error, developer_experience, workflow_issue, best_practice, documentation_gap]
|
|
- **component** (enum): One of [rails_model, rails_controller, rails_view, service_object, background_job, database, frontend_stimulus, hotwire_turbo, email_processing, brief_system, assistant, authentication, payments, development_workflow, testing_framework, documentation, tooling]
|
|
- **symptoms** (array): 1-5 specific observable symptoms
|
|
- **root_cause** (enum): One of [missing_association, missing_include, missing_index, wrong_api, scope_issue, thread_violation, async_timing, memory_leak, config_error, logic_error, test_isolation, missing_validation, missing_permission, missing_workflow_step, inadequate_documentation, missing_tooling, incomplete_setup]
|
|
- **resolution_type** (enum): One of [code_fix, migration, config_change, test_fix, dependency_update, environment_setup, workflow_improvement, documentation_update, tooling_addition, seed_data_update]
|
|
- **severity** (enum): One of [critical, high, medium, low]
|
|
|
|
## Optional Fields
|
|
|
|
- **rails_version** (string): Rails version in X.Y.Z format
|
|
- **tags** (array): Searchable keywords (lowercase, hyphen-separated)
|
|
|
|
## Validation Rules
|
|
|
|
1. All required fields must be present
|
|
2. Enum fields must match allowed values exactly (case-sensitive)
|
|
3. symptoms must be YAML array with 1-5 items
|
|
4. date must match YYYY-MM-DD format
|
|
5. rails_version (if provided) must match X.Y.Z format
|
|
6. tags should be lowercase, hyphen-separated
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
---
|
|
module: Email Processing
|
|
date: 2025-11-12
|
|
problem_type: performance_issue
|
|
component: rails_model
|
|
symptoms:
|
|
- "N+1 query when loading email threads"
|
|
- "Brief generation taking >5 seconds"
|
|
root_cause: missing_include
|
|
rails_version: 7.1.2
|
|
resolution_type: code_fix
|
|
severity: high
|
|
tags: [n-plus-one, eager-loading, performance]
|
|
---
|
|
```
|
|
|
|
## Category Mapping
|
|
|
|
Based on `problem_type`, documentation is filed in:
|
|
|
|
- **build_error** → `docs/solutions/build-errors/`
|
|
- **test_failure** → `docs/solutions/test-failures/`
|
|
- **runtime_error** → `docs/solutions/runtime-errors/`
|
|
- **performance_issue** → `docs/solutions/performance-issues/`
|
|
- **database_issue** → `docs/solutions/database-issues/`
|
|
- **security_issue** → `docs/solutions/security-issues/`
|
|
- **ui_bug** → `docs/solutions/ui-bugs/`
|
|
- **integration_issue** → `docs/solutions/integration-issues/`
|
|
- **logic_error** → `docs/solutions/logic-errors/`
|
|
- **developer_experience** → `docs/solutions/developer-experience/`
|
|
- **workflow_issue** → `docs/solutions/workflow-issues/`
|
|
- **best_practice** → `docs/solutions/best-practices/`
|
|
- **documentation_gap** → `docs/solutions/documentation-gaps/`
|