@fractary/core 0.7.23 → 0.7.25

package/templates/docs/audit/template.md

@@ -0,0 +1,52 @@
+# {{title}}
+
+## Executive Summary
+
+{{summary}}
+
+## Scope
+
+{{scope}}
+
+## Methodology
+
+{{methodology}}
+
+## Findings
+
+{{#findings}}
+### {{id}}: {{title}}
+
+**Severity:** {{severity}}
+**Status:** {{status}}
+
+**Description:**
+{{description}}
+
+**Impact:**
+{{impact}}
+
+**Recommendation:**
+{{recommendation}}
+
+{{/findings}}
+
+## Summary
+
+| Severity | Count |
+|----------|-------|
+| Critical | {{counts.critical}} |
+| High | {{counts.high}} |
+| Medium | {{counts.medium}} |
+| Low | {{counts.low}} |
+| Info | {{counts.info}} |
+
+## Recommendations
+
+{{#recommendations}}
+1. {{.}}
+{{/recommendations}}
+
+## Appendix
+
+{{appendix}}

package/templates/docs/audit/type.yaml

@@ -0,0 +1,61 @@
+# Audit Report Type Definition
+
+id: audit
+display_name: Audit Report
+description: Security audits, compliance checks, and quality assessments
+
+output_path: docs/audits
+
+file_naming:
+  pattern: "AUDIT-{date}-{slug}.md"
+  slug_source: title
+  slug_max_length: 40
+
+frontmatter:
+  required_fields:
+    - title
+    - type
+    - status
+    - date
+    - auditor
+  optional_fields:
+    - scope
+    - tags
+    - related
+    - next_audit_date
+  defaults:
+    type: audit
+    status: draft
+
+structure:
+  required_sections:
+    - Executive Summary
+    - Scope
+    - Findings
+    - Summary
+  optional_sections:
+    - Methodology
+    - Recommendations
+    - Appendix
+  section_order:
+    - Executive Summary
+    - Scope
+    - Methodology
+    - Findings
+    - Summary
+    - Recommendations
+    - Appendix
+
+status:
+  allowed_values:
+    - draft
+    - review
+    - final
+    - archived
+  default: draft
+
+index_config:
+  index_file: docs/audits/README.md
+  sort_by: date
+  sort_order: desc
+  entry_template: "- [{{title}}]({{relative_path}}) - {{date}} ({{status}})"

package/templates/docs/changelog/standards.md

@@ -0,0 +1,15 @@
+# Changelog Documentation Standards
+
+## Required Conventions
+
+- Follow Keep a Changelog format
+- Use Semantic Versioning
+- Group changes by type (Added, Changed, etc.)
+- Include dates for each release
+
+## Best Practices
+
+- Write user-facing descriptions
+- Link to issues/PRs where applicable
+- Document breaking changes clearly
+- Keep entries concise

package/templates/docs/changelog/template.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+{{#releases}}
+## [{{version}}] - {{date}}
+
+{{#added}}
+### Added
+{{#added}}
+- {{.}}
+{{/added}}
+{{/added}}
+
+{{#changed}}
+### Changed
+{{#changed}}
+- {{.}}
+{{/changed}}
+{{/changed}}
+
+{{#deprecated}}
+### Deprecated
+{{#deprecated}}
+- {{.}}
+{{/deprecated}}
+{{/deprecated}}
+
+{{#removed}}
+### Removed
+{{#removed}}
+- {{.}}
+{{/removed}}
+{{/removed}}
+
+{{#fixed}}
+### Fixed
+{{#fixed}}
+- {{.}}
+{{/fixed}}
+{{/fixed}}
+
+{{#security}}
+### Security
+{{#security}}
+- {{.}}
+{{/security}}
+{{/security}}
+
+{{/releases}}

package/templates/docs/changelog/type.yaml

@@ -0,0 +1,45 @@
+# Changelog Type Definition
+
+id: changelog
+display_name: Changelog
+description: Version history and release notes
+
+output_path: docs
+
+file_naming:
+  pattern: "CHANGELOG.md"
+  slug_source: title
+  slug_max_length: 50
+
+frontmatter:
+  required_fields:
+    - title
+    - type
+  optional_fields:
+    - version
+    - date
+  defaults:
+    type: changelog
+    title: Changelog
+
+structure:
+  required_sections: []
+  optional_sections:
+    - Added
+    - Changed
+    - Deprecated
+    - Removed
+    - Fixed
+    - Security
+  section_order:
+    - Added
+    - Changed
+    - Deprecated
+    - Removed
+    - Fixed
+    - Security
+
+status:
+  allowed_values:
+    - current
+  default: current

package/templates/docs/dataset/standards.md

@@ -0,0 +1,15 @@
+# Dataset Documentation Standards
+
+## Required Conventions
+
+- ALWAYS document all fields with types
+- ALWAYS specify required vs optional fields
+- ALWAYS include field descriptions
+- ALWAYS document relationships
+
+## Best Practices
+
+- Include sample data
+- Document validation rules
+- Note data sources
+- Keep schema documentation in sync with code

package/templates/docs/dataset/template.md

@@ -0,0 +1,65 @@
+# {{title}}
+
+## Overview
+
+{{description}}
+
+## Schema
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+{{#fields}}
+| {{name}} | {{type}} | {{required}} | {{description}} |
+{{/fields}}
+
+## Relationships
+
+{{#relationships}}
+### {{name}}
+
+- **Type:** {{type}}
+- **Target:** {{target}}
+- **Description:** {{description}}
+{{/relationships}}
+
+## Indexes
+
+{{#indexes}}
+| Name | Fields | Type |
+|------|--------|------|
+{{#indexes}}
+| {{name}} | {{fields}} | {{type}} |
+{{/indexes}}
+{{/indexes}}
+
+## Data Sources
+
+{{#sources}}
+- **{{name}}**: {{description}}
+{{/sources}}
+
+## Data Quality
+
+### Validation Rules
+
+{{#validation_rules}}
+- {{.}}
+{{/validation_rules}}
+
+### Constraints
+
+{{#constraints}}
+- {{.}}
+{{/constraints}}
+
+## Sample Data
+
+```json
+{{sample_data}}
+```
+
+## Related Datasets
+
+{{#related}}
+- [{{name}}]({{path}})
+{{/related}}

package/templates/docs/dataset/type.yaml

@@ -0,0 +1,63 @@
+# Dataset Documentation Type Definition
+
+id: dataset
+display_name: Dataset Documentation
+description: Data schema documentation and field definitions
+
+output_path: docs/data
+
+file_naming:
+  pattern: "DATA-{slug}.md"
+  slug_source: title
+  slug_max_length: 50
+
+frontmatter:
+  required_fields:
+    - title
+    - type
+    - status
+    - date
+  optional_fields:
+    - owner
+    - version
+    - tags
+    - related
+    - source
+  defaults:
+    type: dataset
+    status: draft
+
+structure:
+  required_sections:
+    - Overview
+    - Schema
+  optional_sections:
+    - Relationships
+    - Indexes
+    - Data Sources
+    - Data Quality
+    - Sample Data
+    - Related Datasets
+  section_order:
+    - Overview
+    - Schema
+    - Relationships
+    - Indexes
+    - Data Sources
+    - Data Quality
+    - Sample Data
+    - Related Datasets
+
+status:
+  allowed_values:
+    - draft
+    - review
+    - approved
+    - deprecated
+  default: draft
+
+index_config:
+  index_file: docs/data/README.md
+  sort_by: title
+  sort_order: asc
+  entry_template: "- [{{title}}]({{relative_path}}) - {{status}}"

package/templates/docs/etl/standards.md

@@ -0,0 +1,15 @@
+# ETL Pipeline Documentation Standards
+
+## Required Conventions
+
+- ALWAYS document data sources
+- ALWAYS document transformations
+- ALWAYS document destinations
+- ALWAYS include scheduling information
+
+## Best Practices
+
+- Include pipeline diagrams
+- Document error handling
+- Set up monitoring and alerts
+- Track data lineage

package/templates/docs/etl/template.md

@@ -0,0 +1,77 @@
+# {{title}}
+
+## Overview
+
+{{description}}
+
+## Pipeline Diagram
+
+```mermaid
+{{diagram}}
+```
+
+## Sources
+
+{{#sources}}
+### {{name}}
+
+- **Type:** {{type}}
+- **Connection:** {{connection}}
+- **Schedule:** {{schedule}}
+- **Description:** {{description}}
+{{/sources}}
+
+## Transformations
+
+{{#transformations}}
+### {{name}}
+
+**Input:** {{input}}
+**Output:** {{output}}
+
+{{description}}
+
+```{{language}}
+{{code}}
+```
+{{/transformations}}
+
+## Destinations
+
+{{#destinations}}
+### {{name}}
+
+- **Type:** {{type}}
+- **Connection:** {{connection}}
+- **Mode:** {{mode}}
+{{/destinations}}
+
+## Schedule
+
+- **Frequency:** {{schedule.frequency}}
+- **Timezone:** {{schedule.timezone}}
+- **Dependencies:** {{schedule.dependencies}}
+
+## Monitoring
+
+### Alerts
+
+{{#alerts}}
+- **{{name}}**: {{condition}} → {{action}}
+{{/alerts}}
+
+### Metrics
+
+{{#metrics}}
+- {{name}}: {{description}}
+{{/metrics}}
+
+## Error Handling
+
+{{error_handling}}
+
+## Related Pipelines
+
+{{#related}}
+- [{{name}}]({{path}})
+{{/related}}

package/templates/docs/etl/type.yaml

@@ -0,0 +1,66 @@
+# ETL Pipeline Documentation Type Definition
+
+id: etl
+display_name: ETL Pipeline Documentation
+description: Data pipeline and ETL job documentation
+
+output_path: docs/etl
+
+file_naming:
+  pattern: "ETL-{slug}.md"
+  slug_source: title
+  slug_max_length: 50
+
+frontmatter:
+  required_fields:
+    - title
+    - type
+    - status
+    - date
+  optional_fields:
+    - owner
+    - schedule
+    - tags
+    - related
+    - dependencies
+  defaults:
+    type: etl
+    status: draft
+
+structure:
+  required_sections:
+    - Overview
+    - Sources
+    - Transformations
+    - Destinations
+  optional_sections:
+    - Pipeline Diagram
+    - Schedule
+    - Monitoring
+    - Error Handling
+    - Related Pipelines
+  section_order:
+    - Overview
+    - Pipeline Diagram
+    - Sources
+    - Transformations
+    - Destinations
+    - Schedule
+    - Monitoring
+    - Error Handling
+    - Related Pipelines
+
+status:
+  allowed_values:
+    - draft
+    - development
+    - staging
+    - production
+    - deprecated
+  default: draft
+
+index_config:
+  index_file: docs/etl/README.md
+  sort_by: title
+  sort_order: asc
+  entry_template: "- [{{title}}]({{relative_path}}) - {{status}}"

package/templates/docs/guides/standards.md

@@ -0,0 +1,16 @@
+# Guide Documentation Standards
+
+## Required Conventions
+
+- ALWAYS include clear overview
+- ALWAYS list prerequisites
+- ALWAYS provide step-by-step instructions
+- ALWAYS include verification steps
+
+## Best Practices
+
+- Use numbered steps
+- Include code examples
+- Add troubleshooting section
+- Link to related guides
+- Specify difficulty level

package/templates/docs/guides/template.md

@@ -0,0 +1,58 @@
+# {{title}}
+
+## Overview
+
+{{overview}}
+
+## Prerequisites
+
+{{#prerequisites}}
+- {{.}}
+{{/prerequisites}}
+
+## Steps
+
+{{#steps}}
+### Step {{number}}: {{title}}
+
+{{description}}
+
+{{#code}}
+```{{language}}
+{{code}}
+```
+{{/code}}
+
+{{#note}}
+> **Note:** {{note}}
+{{/note}}
+
+{{#warning}}
+> **Warning:** {{warning}}
+{{/warning}}
+
+{{/steps}}
+
+## Verification
+
+{{verification}}
+
+## Troubleshooting
+
+{{#troubleshooting}}
+### {{problem}}
+
+**Solution:** {{solution}}
+{{/troubleshooting}}
+
+## Next Steps
+
+{{#next_steps}}
+- [{{title}}]({{path}})
+{{/next_steps}}
+
+## Related Guides
+
+{{#related}}
+- [{{title}}]({{path}})
+{{/related}}

package/templates/docs/guides/type.yaml

@@ -0,0 +1,61 @@
+# How-to Guide Type Definition
+
+id: guides
+display_name: How-to Guide
+description: Step-by-step tutorials and how-to guides
+
+output_path: docs/guides
+
+file_naming:
+  pattern: "GUIDE-{slug}.md"
+  slug_source: title
+  slug_max_length: 50
+
+frontmatter:
+  required_fields:
+    - title
+    - type
+    - date
+  optional_fields:
+    - author
+    - difficulty
+    - time_required
+    - tags
+    - related
+    - prerequisites
+  defaults:
+    type: guides
+    difficulty: intermediate
+
+structure:
+  required_sections:
+    - Overview
+    - Prerequisites
+    - Steps
+  optional_sections:
+    - Verification
+    - Troubleshooting
+    - Next Steps
+    - Related Guides
+  section_order:
+    - Overview
+    - Prerequisites
+    - Steps
+    - Verification
+    - Troubleshooting
+    - Next Steps
+    - Related Guides
+
+status:
+  allowed_values:
+    - draft
+    - review
+    - published
+    - outdated
+  default: draft
+
+index_config:
+  index_file: docs/guides/README.md
+  sort_by: title
+  sort_order: asc
+  entry_template: "- [{{title}}]({{relative_path}}) - {{difficulty}}"

package/templates/docs/infrastructure/standards.md

@@ -0,0 +1,15 @@
+# Infrastructure Documentation Standards
+
+## Required Conventions
+
+- ALWAYS document all resources
+- ALWAYS include deployment procedures
+- ALWAYS document security configuration
+- ALWAYS include runbook operations
+
+## Best Practices
+
+- Include architecture diagrams
+- Document monitoring and alerts
+- Maintain runbooks for common operations
+- Document incident response procedures