Skip to content

Commit 8325245

Browse files
zackkatzzackkatz
committed
MAESTRO: Add hook templates for code samples, use cases, and enhanced hook pages
Created three new template files in templates/hooks/: - hook-page.md: Main template for individual hook pages with Quick Example, Advanced Usage (collapsible), Related Hooks, and Use Cases sections - code-sample.md: Flexible template supporting basic, practical, advanced, and inline code sample formats - use-case.md: Template for use case descriptions with scenario, code, and tip support
1 parent 06b97f8 commit 8325245

3 files changed

Lines changed: 204 additions & 0 deletions

File tree

‎templates/hooks/code-sample.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{{#isBasic}}
2+
## Quick Example
3+
4+
A minimal example showing how to use this {{hookType}}:
5+
6+
```php
7+
{{code}}
8+
```
9+
{{/isBasic}}
10+
11+
{{#isPractical}}
12+
## Practical Example
13+
14+
A real-world scenario demonstrating {{context}}:
15+
16+
```php
17+
{{code}}
18+
```
19+
{{/isPractical}}
20+
21+
{{#isAdvanced}}
22+
<details>
23+
<summary>Advanced Usage</summary>
24+
25+
{{#hasDescription}}
26+
{{description}}
27+
28+
{{/hasDescription}}
29+
A comprehensive example with error handling, caching, and best practices:
30+
31+
```php
32+
{{code}}
33+
```
34+
35+
**Key Features:**
36+
{{#hasFeatures}}
37+
{{featuresList}}
38+
{{/hasFeatures}}
39+
40+
</details>
41+
{{/isAdvanced}}
42+
43+
{{#isInline}}
44+
```php
45+
{{code}}
46+
```
47+
{{/isInline}}

‎templates/hooks/hook-page.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
id: {{hookId}}
3+
title: "{{hookType}} - {{hookName}}"
4+
sidebar_label: "{{hookName}}"
5+
{{#hasTags}}
6+
tags:
7+
{{tagsList}}
8+
{{/hasTags}}
9+
{{#hasSourceClass}}
10+
source_class: "{{sourceClass}}"
11+
{{/hasSourceClass}}
12+
{{#hasSourceNamespace}}
13+
source_namespace: "{{sourceNamespace}}"
14+
{{/hasSourceNamespace}}
15+
{{#hasSourceMethod}}
16+
source_method: "{{sourceMethod}}"
17+
{{/hasSourceMethod}}
18+
{{#hasCodeContext}}
19+
code_context: {{codeContext}}
20+
{{/hasCodeContext}}
21+
{{#hasInlineComments}}
22+
inline_comments: {{inlineComments}}
23+
{{/hasInlineComments}}
24+
{{#hasRelatedHooks}}
25+
related_hooks: {{relatedHooksJson}}
26+
{{/hasRelatedHooks}}
27+
---
28+
29+
# {{hookType}}: {{hookName}}
30+
31+
{{#isDeprecated}}
32+
:::warning[Deprecated]
33+
34+
{{deprecatedMessage}}
35+
36+
:::
37+
38+
{{/isDeprecated}}
39+
{{description}}
40+
41+
{{#hasQuickExample}}
42+
## Quick Example
43+
44+
A minimal example showing how to use this {{hookTypeLower}}:
45+
46+
```php
47+
{{quickExample}}
48+
```
49+
50+
{{/hasQuickExample}}
51+
{{#hasParameters}}
52+
## Parameters
53+
54+
| Name | Type | Description |
55+
|------|------|-------------|
56+
{{parameterRows}}
57+
58+
{{/hasParameters}}
59+
{{#hasReturnType}}
60+
## Returns
61+
62+
| Type | Description |
63+
|------|-------------|
64+
| {{returnType}} | {{returnDescription}} |
65+
66+
{{/hasReturnType}}
67+
{{#hasAdvancedUsage}}
68+
<details>
69+
<summary>Advanced Usage</summary>
70+
71+
A more comprehensive example with error handling and best practices:
72+
73+
```php
74+
{{advancedExample}}
75+
```
76+
77+
</details>
78+
79+
{{/hasAdvancedUsage}}
80+
{{#hasUseCases}}
81+
## Use Cases
82+
83+
{{useCasesList}}
84+
85+
{{/hasUseCases}}
86+
{{#hasRelatedHooks}}
87+
## Related Hooks
88+
89+
{{relatedHooksList}}
90+
91+
{{/hasRelatedHooks}}
92+
{{#hasSince}}
93+
### Since
94+
95+
{{sinceList}}
96+
97+
{{/hasSince}}
98+
### Source
99+
100+
Defined in `{{sourceFile}}` at line {{sourceLine}}

‎templates/hooks/use-case.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
## Use Cases
2+
3+
{{#useCases}}
4+
### {{title}}
5+
6+
{{description}}
7+
8+
{{#hasScenario}}
9+
**Scenario:** {{scenario}}
10+
11+
{{/hasScenario}}
12+
{{#hasCode}}
13+
```php
14+
{{code}}
15+
```
16+
{{/hasCode}}
17+
18+
{{#hasNotes}}
19+
:::tip
20+
21+
{{notes}}
22+
23+
:::
24+
25+
{{/hasNotes}}
26+
{{/useCases}}
27+
28+
{{#hasSingleUseCase}}
29+
### {{title}}
30+
31+
{{description}}
32+
33+
{{#hasScenario}}
34+
**Scenario:** {{scenario}}
35+
36+
{{/hasScenario}}
37+
{{#hasCode}}
38+
```php
39+
{{code}}
40+
```
41+
{{/hasCode}}
42+
43+
{{#hasNotes}}
44+
:::tip
45+
46+
{{notes}}
47+
48+
:::
49+
50+
{{/hasNotes}}
51+
{{/hasSingleUseCase}}
52+
53+
{{#hasUseCaseList}}
54+
Common use cases for this {{hookType}}:
55+
56+
{{useCaseList}}
57+
{{/hasUseCaseList}}

0 commit comments

Comments
 (0)