feat: enhance documentation with consistent markdown formatting and new implementation plan for prompt engineering toolkit

Author: mihazs

apps/docs/docs/explanation/prompt-engineering.md

@@ -69,7 +69,7 @@ Petk treats prompts as structured content rather than code, making them accessib
 **Modular Composition**
 Break complex prompts into reusable components that can be combined and recombined for different scenarios:
 
-`````markdown
+````markdown
 <!-- Base instruction template -->
 ```{petk:include}
 path: instructions/base-reasoning.md
@@ -86,7 +86,7 @@ limit: 3
 ```{petk:include}
 path: context/{{domain}}/current-context.md
 ```
-`````
+````
 
 **Systematic Experimentation**
 Support for deterministic prompt variant generation enables systematic A/B testing and optimization:
@@ -145,7 +145,7 @@ limit: "{{max_examples}}"
 
 ## Your Task
 
-\{\{current_task\}\}
+\\{\\{current_task\\}\\}
 ````
 
 **Benefits**:
@@ -171,7 +171,7 @@ path: reasoning/examples/{{domain}}/*.md
 
 ## Problem to Solve
 
-\{\{problem_statement\}\}
+\\{\\{problem_statement\\}\\}
 
 Think through this step by step:
 1. **Understanding**: What is being asked?
@@ -237,7 +237,7 @@ if: model.type !== 'gpt-4' && model.type !== 'claude'
 
 ## Task
 
-\{\{task_description\}\}
+\\{\\{task_description\\}\\}
 
 ```{petk:include}
 path: examples/{{model.type}}-examples/*.md
@@ -324,13 +324,13 @@ prompts/
 **Best Practice Documentation**:
 ````markdown
 <!-- Meta-template for documenting patterns -->
-# \{\{pattern_name\}\} Pattern
+# \\{\\{pattern_name\\}\\} Pattern
 
 ## Purpose
-\{\{pattern_description\}\}
+\\{\\{pattern_description\\}\\}
 
 ## When to Use
-\{\{use_cases\}\}
+\\{\\{use_cases\\}\\}
 
 ## Template
 ```{petk:include}
@@ -343,7 +343,7 @@ path: examples/{{pattern_name}}/*.md
 ```
 
 ## Variations
-\{\{pattern_variations\}\}
+\\{\\{pattern_variations\\}\\}
 ````
 
 ## Measuring Success in Prompt Engineering

apps/docs/docs/learning/first-template.md

@@ -284,7 +284,7 @@ path: ../components/ethical-framework.md
 Build sophisticated templates that demonstrate complex include patterns:
 
 **templates/persona-generator.md:**
-```markdown
+````markdown
 ---
 generator: AI Persona Assembly System
 version: "`{{version}}`"
@@ -312,7 +312,7 @@ sampling_method: "deterministic"
 
 ## Contextual Adaptations
 
-Based on the specified use case: **\{\{use_case\}\}**
+Based on the specified use case: **\\{\\{use_case\\}\\}**
 
 ```{petk:include}
 glob: "adaptations/`{{use_case}}`/*.md"
@@ -334,7 +334,7 @@ This persona definition should be used as a system prompt for AI assistants. Key
 
 *Template processed with Petk v`{{version}}` - `{{project_name}}`*
 *For questions or customization, refer to the template documentation.*
-```
+````
 
 ### 7. Add Enhancement Modules
 
@@ -420,7 +420,7 @@ petk validate templates/persona-generator.md
 Add conditional logic to your templates:
 
 **templates/adaptations/enterprise_consulting/security-focus.md:**
-```markdown
+````markdown
 ## Security-First Approach
 
 When working with enterprise clients, prioritize:
@@ -434,14 +434,14 @@ When working with enterprise clients, prioritize:
 path: "../../components/security-checklist.md"
 condition: "`{{security_level}}` == 'high'"
 ```
-```
+````
 
 ### 11. Dynamic Content Sampling
 
 Use sampling for variety in generated content:
 
 **templates/persona-generator.md** (enhanced section):
-```markdown
+````markdown
 ## Personality Variations
 
 ```{petk:include}
@@ -450,7 +450,7 @@ sampling_method: "deterministic"
 sample_size: 3
 seed: "`{{role_type}}`"
 ```
-```
+````
 
 ### 12. Hierarchical Organization
 

apps/docs/docs/learning/getting-started.md

@@ -84,7 +84,7 @@ You can customize these settings for your project needs.
 
 Create a simple template file at `templates/welcome.md`:
 
-```markdown
+````markdown
 # Welcome to {{project_name}}
 
 This is a template created by {{author}}.
@@ -95,7 +95,7 @@ path: snippets/common-instructions.md
 
 ## Project Overview
 This project demonstrates Petk's template processing capabilities.
-```
+````
 
 Create the included snippet at `templates/snippets/common-instructions.md`:
 
@@ -172,13 +172,13 @@ Use markdown code blocks with the `{petk:include}` directive to dynamically incl
 
 ### Advanced Includes
 Petk supports sophisticated include patterns:
-```markdown
+````markdown
 ```{petk:include}
 glob: "examples/*.md"
 order_by: "last_updated_desc"
 limit: 5
 ```
-```
+````
 
 ## Development Workflow
 

apps/docs/docs/learning/intro.md

@@ -37,7 +37,7 @@ yarn global add petk
 
 1. Create a new Markdown file called `example.md`:
 
-```markdown
+````markdown
 # My First Template
 
 This is a basic template that will be processed by Petk.
@@ -51,7 +51,7 @@ Welcome to the content section!
 ```{petk:include}
 path: footer.md
 ```
-```
+````
 
 2. Create the included files:
 

apps/docs/docs/problems/common-issues.md

@@ -104,7 +104,7 @@ petk process your-file.md --verbose
    ````
 
 2. **Verify file paths are correct:**
-   ```markdown
+   ````markdown
    <!-- Use relative paths -->
    ```{petk:include}
    path: ./components/header.md
@@ -114,7 +114,7 @@ petk process your-file.md --verbose
    ```{petk:include}
    path: /templates/shared/footer.md
    ```
-   ```
+   ````
 
 3. **Check file encoding:**
    ```bash
@@ -135,11 +135,11 @@ petk process your-file.md --verbose
    ```
 
 2. **Use absolute paths:**
-   ```markdown
+   ````markdown
    ```{petk:include}
    path: /full/path/to/file.md
    ```
-   ```
+   ````
 
 3. **Set base directory in configuration:**
    ```javascript
@@ -409,7 +409,7 @@ petk validate ./templates/ --check-circular
    ```
 
 2. **Restructure includes:**
-   ```markdown
+   ````markdown
    <!-- Instead of mutual includes, use a common base -->
    <!-- base.md -->
    ```{petk:include}
@@ -421,15 +421,15 @@ petk validate ./templates/ --check-circular
    ```{petk:include}
    path: footer.md
    ```
-   ```
+   ````
 
 3. **Use conditional includes:**
-   ```markdown
+   ````markdown
    ```{petk:include}
    path: header.md
    if: !included.header
    ```
-   ```
+   ````
 
 ## Getting Help