Skip to content

Commit 3af36d3

Browse files
zackkatzzackkatz
committed
MAESTRO: Add documentation audit and enhancement foundation
- Add audit-hooks.mjs script for comprehensive hook coverage analysis - Generate baseline audit-report.json with 1942 hooks across 28 products - Create video-candidates.md tracking system for video documentation - Create visual-enhancement-plan.md with CSS enhancement roadmap - Add content-dimensions.json schema for multi-dimensional content - Add generate-enhanced-hooks.mjs prototype for enhanced documentation Audit findings: - 26% hooks have code examples (509/1942) - 100% have descriptions - 83% have @SInCE version info (1613/1942) - 35 hooks have malformed parameters - Top priorities: gravityview (510), gravityforms (455)
1 parent 42a4bdd commit 3af36d3

6 files changed

Lines changed: 7485 additions & 1 deletion

File tree

‎claudedocs/video-candidates.md‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
---
2+
type: reference
3+
title: Video Candidate Tracking
4+
created: 2026-02-03
5+
tags:
6+
- video
7+
- documentation
8+
- media
9+
related:
10+
- "[[audit-report]]"
11+
- "[[visual-enhancement-plan]]"
12+
---
13+
14+
# Video Candidate Tracking
15+
16+
This document tracks hooks and features that would benefit from video documentation. Videos are prioritized based on complexity (parameter count, related hooks), frequency of use, and potential for demonstrating real-world scenarios.
17+
18+
## Template Entry
19+
20+
Each video candidate should include:
21+
- **Hook Name**: The hook identifier
22+
- **Product**: Which GravityKit product
23+
- **Est. Length**: Approximate video duration
24+
- **Target Audience**: Developer, Agency, Site Builder, or Site Owner
25+
- **Description**: What the video would demonstrate
26+
27+
---
28+
29+
## High Priority
30+
31+
Complex concepts requiring visual demonstration to understand properly. These hooks have 4+ parameters, involve multiple related hooks, or represent core functionality that's difficult to grasp through text alone.
32+
33+
### 1. Edit Entry Lifecycle Hooks
34+
35+
| Field | Value |
36+
|-------|-------|
37+
| **Hook Name** | `gravityview/edit_entry/before_update` & `gravityview/edit_entry/after_update` |
38+
| **Product** | GravityView |
39+
| **Est. Length** | 8-10 minutes |
40+
| **Target Audience** | Developer |
41+
| **Description** | Demonstrates the complete Edit Entry update lifecycle: how to intercept entry data before save, perform validation or transformation, and execute post-save actions. Shows all 4 parameters (`$form`, `$entry_id`, `$this`, `$gv_data`) and how they interact. Includes practical example of sending notifications to external systems after entry updates. |
42+
43+
### 2. View Editor Area Actions
44+
45+
| Field | Value |
46+
|-------|-------|
47+
| **Hook Name** | `gk/gravityview/admin-views/area/actions` |
48+
| **Product** | GravityView |
49+
| **Est. Length** | 6-8 minutes |
50+
| **Target Audience** | Developer |
51+
| **Description** | Shows how to add custom actions inside the View editor's droppable areas. Covers all 6 parameters (`$area`, `$type`, `$values`, `$is_dynamic`, `$template_id`, `$zone`) with live demonstration of adding custom buttons or controls to specific zones. Useful for agencies building View customization tools. |
52+
53+
### 3. Lightbox Entry Customization
54+
55+
| Field | Value |
56+
|-------|-------|
57+
| **Hook Name** | `gk/gravityview/lightbox/entry/before-output` and related hooks |
58+
| **Product** | GravityView |
59+
| **Est. Length** | 10-12 minutes |
60+
| **Target Audience** | Developer, Agency |
61+
| **Description** | Comprehensive walkthrough of the 6 lightbox entry hooks for customizing modal entry views. Shows the View, Entry, Form, and Renderer objects. Demonstrates adding custom header content, modifying entry display, and injecting footer elements. Includes CSS styling considerations. |
62+
63+
### 4. Template Field Rendering
64+
65+
| Field | Value |
66+
|-------|-------|
67+
| **Hook Name** | `gk/gravityview/template/before-field-render` |
68+
| **Product** | GravityView |
69+
| **Est. Length** | 5-7 minutes |
70+
| **Target Audience** | Developer |
71+
| **Description** | Explains field rendering lifecycle with 5 parameters: `$field_type`, `$key`, `$option`, `$current`, `$context`. Shows how to conditionally modify field output, add wrapper elements, or inject custom content before specific field types render. |
72+
73+
### 5. Edit Entry Permission Control
74+
75+
| Field | Value |
76+
|-------|-------|
77+
| **Hook Name** | `gravityview/edit_entry/user_can_edit_entry` |
78+
| **Product** | GravityView |
79+
| **Est. Length** | 6-8 minutes |
80+
| **Target Audience** | Developer, Agency |
81+
| **Description** | Deep dive into permission logic for Edit Entry. Shows how to implement custom permission rules based on user roles, entry field values, or external conditions. Demonstrates security best practices and common use cases like time-limited editing or supervisor approval workflows. |
82+
83+
---
84+
85+
## Medium Priority
86+
87+
Common use cases that would benefit from visual explanation but can be understood through documentation.
88+
89+
### 6. Entry Notes Integration
90+
91+
| Field | Value |
92+
|-------|-------|
93+
| **Hook Name** | `gform_post_send_entry_note` |
94+
| **Product** | GravityView |
95+
| **Est. Length** | 4-5 minutes |
96+
| **Target Audience** | Developer |
97+
| **Description** | Shows the 7-parameter hook for extending entry note functionality. Demonstrates integration with external notification systems (Slack, email, CRM) when notes are added to entries. |
98+
99+
### 7. Delete Entry Workflow
100+
101+
| Field | Value |
102+
|-------|-------|
103+
| **Hook Name** | `gk/gravityview/delete-entry/can-delete` and related |
104+
| **Product** | GravityView |
105+
| **Est. Length** | 5-6 minutes |
106+
| **Target Audience** | Developer, Agency |
107+
| **Description** | Covers the delete entry permission system including soft delete vs permanent delete, connected post handling, and confirmation dialogs. Shows how to implement "archive" functionality instead of deletion. |
108+
109+
### 8. View Row Customization
110+
111+
| Field | Value |
112+
|-------|-------|
113+
| **Hook Name** | `gk/gravityview/admin-views/row-before` & `gk/gravityview/admin-views/row-after` |
114+
| **Product** | GravityView |
115+
| **Est. Length** | 4-5 minutes |
116+
| **Target Audience** | Developer |
117+
| **Description** | Demonstrates adding custom content before or after View rows in the admin area. Shows practical examples of adding status indicators, action buttons, or contextual information. |
118+
119+
---
120+
121+
## Low Priority
122+
123+
Nice-to-have videos for advanced use cases or less common scenarios.
124+
125+
### 9. Entry Slug Customization
126+
127+
| Field | Value |
128+
|-------|-------|
129+
| **Hook Name** | `gravityview_custom_entry_slug` |
130+
| **Product** | GravityView |
131+
| **Est. Length** | 3-4 minutes |
132+
| **Target Audience** | Developer |
133+
| **Description** | Shows how to create SEO-friendly or human-readable entry URLs instead of numeric IDs. Includes examples using entry field values or custom patterns. |
134+
135+
### 10. Search Widget Field Customization
136+
137+
| Field | Value |
138+
|-------|-------|
139+
| **Hook Name** | `gravityview_search_widget_field_before` & `gravityview_search_widget_field_after` |
140+
| **Product** | GravityView |
141+
| **Est. Length** | 4-5 minutes |
142+
| **Target Audience** | Developer |
143+
| **Description** | Demonstrates customizing individual search fields including adding help text, custom labels, or wrapper elements around search inputs. |
144+
145+
---
146+
147+
## Notes
148+
149+
- Videos should be recorded at 1920x1080 resolution
150+
- Include closed captions for accessibility
151+
- Host on GravityKit's YouTube channel with embedding on docs site
152+
- Consider creating short-form versions (< 60 seconds) for social media
153+
- Track video performance metrics to prioritize future content
154+
155+
## Selection Criteria
156+
157+
When adding new video candidates, consider:
158+
1. **Parameter complexity**: Hooks with 4+ parameters often need visual explanation
159+
2. **Related hooks**: Groups of hooks that work together benefit from unified demos
160+
3. **Support ticket frequency**: Hooks frequently asked about in Help Scout
161+
4. **Use case commonality**: Features used by majority of customers
162+
5. **Visual nature**: Concepts that are easier to show than describe

0 commit comments

Comments
 (0)