Skip to content

Commit ac51905

Browse files
author
Nick Sullivan
committed
✨ Reformat documentation for improved readability and consistency
Standardized line wrapping at 72 characters across all markdown documentation and configuration files. Improved visual hierarchy and consistency in formatting while maintaining semantic meaning. Added missing newline at EOF in several files and updated spell-check config.
1 parent 0942946 commit ac51905

File tree

8 files changed

+161
-79
lines changed

8 files changed

+161
-79
lines changed

.claude/commands/ai-coding-config.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@ provide actionable recommendations:
126126
**Always check and recommend:**
127127

128128
1. **Generate AGENTS.md** - If `AGENTS.md` doesn't exist at project root:
129+
129130
```
130131
📋 Recommended: Generate project context file for AI assistants
131132
Run: /generate-AGENTS-file

.claude/commands/create-prompt.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
11
---
2-
description: Create optimized prompts for complex tasks and save them with descriptive names
2+
description:
3+
Create optimized prompts for complex tasks and save them with descriptive names
34
argument-hint: <task description>
45
---
56

67
# Create Prompt
78

8-
You are an expert prompt engineer. Create a well-structured prompt for the task described in: ${ARGUMENTS}
9+
You are an expert prompt engineer. Create a well-structured prompt for the task
10+
described in: ${ARGUMENTS}
911

1012
## Process
1113

1214
### 1. Analyze the Request
1315

1416
If the request is vague, ask for clarification:
15-
- Use AskUserQuestion when there are clear, discrete options (e.g., "Auth method?" → JWT/OAuth/Session)
16-
- Use free-form response for descriptions, specifics, or examples (e.g., "What error are you seeing?")
17+
18+
- Use AskUserQuestion when there are clear, discrete options (e.g., "Auth method?" →
19+
JWT/OAuth/Session)
20+
- Use free-form response for descriptions, specifics, or examples (e.g., "What error are
21+
you seeing?")
1722

1823
### 2. Create the Prompt
1924

2025
Structure the prompt using XML tags for clarity:
26+
2127
- Clear objective and context
2228
- Specific requirements and constraints
2329
- Expected output and success criteria
@@ -26,6 +32,7 @@ Structure the prompt using XML tags for clarity:
2632
### 3. Save the Prompt
2733

2834
First, ensure `.created-prompts/` exists:
35+
2936
```bash
3037
if [ ! -d ".created-prompts" ]; then
3138
mkdir .created-prompts
@@ -37,13 +44,15 @@ fi
3744
```
3845

3946
Save with a descriptive Title-Case-With-Hyphens name:
47+
4048
- `Implement-User-Authentication.md`
4149
- `Fix-Database-Connection-Bug.md`
4250
- `Add-Dashboard-Analytics.md`
4351

4452
### 4. Offer to Execute
4553

4654
After saving:
55+
4756
```
4857
✓ Saved to .created-prompts/Your-Task-Name.md
4958
@@ -58,4 +67,4 @@ If yes, execute with Task tool (subagent_type: "general-purpose").
5867
- Just well-crafted prompts in markdown files
5968
- Descriptive filenames are the documentation
6069
- Directory only created when needed
61-
- .gitignore only updated on first use
70+
- .gitignore only updated on first use
Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,49 @@
11
---
2-
description: Generate comprehensive context handoff and copy to clipboard for continuing work
2+
description:
3+
Generate comprehensive context handoff and copy to clipboard for continuing work
34
---
45

56
# Handoff Context
67

7-
Generate a comprehensive context handoff for the current conversation that can be cleanly copied and pasted to continue work in a new session.
8+
Generate a comprehensive context handoff for the current conversation that can be
9+
cleanly copied and pasted to continue work in a new session.
810

911
## Instructions
1012

11-
1. **Generate the handoff** - Create a complete context handoff following the XML-structured format
13+
1. **Generate the handoff** - Create a complete context handoff following the
14+
XML-structured format
1215
2. **Save to temp file** - Use Write tool to save to `/tmp/context_handoff.md`
13-
3. **Copy to clipboard automatically** - Use `pbcopy < /tmp/context_handoff.md` without asking
16+
3. **Copy to clipboard automatically** - Use `pbcopy < /tmp/context_handoff.md` without
17+
asking
1418
4. **Show brief confirmation** - Just `📋 Copied to clipboard`
1519

1620
## Process
1721

1822
### Step 1: Generate the Handoff
1923

20-
Create the handoff in this exact format (don't output to user yet, you'll save it directly to file):
24+
Create the handoff in this exact format (don't output to user yet, you'll save it
25+
directly to file):
2126

2227
```markdown
2328
# Context Handoff
2429

2530
<context_handoff>
2631

27-
<original_task>
28-
[State the original, specific request or task]
29-
</original_task>
32+
<original_task> [State the original, specific request or task] </original_task>
3033

31-
<work_completed>
32-
[List everything successfully accomplished with file paths and line numbers]
33-
</work_completed>
34+
<work_completed> [List everything successfully accomplished with file paths and line
35+
numbers] </work_completed>
3436

35-
<work_remaining>
36-
[Detail work that still needs to be done with priorities]
37+
<work_remaining> [Detail work that still needs to be done with priorities]
3738
</work_remaining>
3839

39-
<attempted_approaches>
40-
[Document approaches that didn't work and why]
40+
<attempted_approaches> [Document approaches that didn't work and why]
4141
</attempted_approaches>
4242

43-
<critical_context>
44-
[Preserve essential technical, project, and business context]
43+
<critical_context> [Preserve essential technical, project, and business context]
4544
</critical_context>
4645

47-
<current_state>
48-
[Describe exact state of deliverables and system]
49-
</current_state>
46+
<current_state> [Describe exact state of deliverables and system] </current_state>
5047

5148
<recommendations>
5249
[Provide actionable next steps in priority order]
@@ -64,20 +61,23 @@ Create the handoff in this exact format (don't output to user yet, you'll save i
6461
3. Confirm: `📋 Copied to clipboard`
6562

6663
**Why Write tool instead of heredoc?**
64+
6765
- Avoids triggering git hooks (heredoc with `<<` can trigger branch protection)
6866
- Cleaner, no escaping issues
6967
- Faster execution
7068

7169
## Important Guidelines
7270

7371
**For Clean Copy/Paste:**
72+
7473
- Start output with `# Context Handoff` and nothing else
7574
- End with `</context_handoff>` and nothing else
7675
- No "Here's your handoff:" or "I've generated:" preambles
7776
- No "This handoff documents..." summaries after
7877
- Just the pure handoff content
7978

8079
**For Comprehensive Documentation:**
80+
8181
- Include specific file paths with line numbers (e.g., `src/auth.ts:45-67`)
8282
- Document ALL work completed, even minor changes
8383
- Include failed attempts to prevent repetition
@@ -86,6 +86,7 @@ Create the handoff in this exact format (don't output to user yet, you'll save i
8686
- Include git status and branch info
8787

8888
**For Clipboard Operation:**
89+
8990
1. Use Write tool to save to `/tmp/context_handoff.md` (avoids heredoc hook triggers)
9091
2. Run: `pbcopy < /tmp/context_handoff.md` (single fast command)
9192
3. Show: `📋 Copied to clipboard` (brief confirmation)
@@ -95,6 +96,7 @@ Create the handoff in this exact format (don't output to user yet, you'll save i
9596
User: `/handoff-context`
9697

9798
Assistant immediately:
99+
98100
1. Generates the handoff content
99101
2. Uses Write tool to save to `/tmp/context_handoff.md`
100102
3. Runs `pbcopy < /tmp/context_handoff.md`
@@ -110,4 +112,4 @@ No prompts, no asking, just fast automatic clipboard copy.
110112
- The new Claude instance should be able to continue work without any additional context
111113
- Include the markdown header `# Context Handoff` so it renders nicely when pasted
112114
- Use pbcopy for Mac clipboard integration (pbpaste can verify if needed)
113-
- The temp file ensures clean content without shell escaping issues
115+
- The temp file ensures clean content without shell escaping issues

.claude/commands/product-intel.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
description: Run comprehensive product intelligence research on competitors and industry trends
2+
description:
3+
Run comprehensive product intelligence research on competitors and industry trends
34
argument-hint: [competitor name | topic | "all"]
45
---
56

.claude/skills/youtube-transcript-analyzer/SKILL.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
name: youtube-transcript-analyzer
33
description:
4-
Use when analyzing YouTube videos for research, learning, or understanding how
5-
content relates to a project - downloads transcripts with yt-dlp, chunks long
6-
content, and provides context-aware analysis
4+
Use when analyzing YouTube videos for research, learning, or understanding how content
5+
relates to a project - downloads transcripts with yt-dlp, chunks long content, and
6+
provides context-aware analysis
77
---
88

99
# YouTube Transcript Analyzer
@@ -43,7 +43,8 @@ yt-dlp --version
4343

4444
### Setup Temporary Directory
4545

46-
IMPORTANT: Always create and use a temporary directory for downloaded files to avoid cluttering the repository:
46+
IMPORTANT: Always create and use a temporary directory for downloaded files to avoid
47+
cluttering the repository:
4748

4849
```bash
4950
# Create temporary directory for this analysis
@@ -153,14 +154,14 @@ yt-dlp --skip-download --write-auto-sub --sub-lang en --sub-format vtt \
153154

154155
## Best Practices
155156

156-
Focus analysis on practical application rather than comprehensive summaries. Users
157-
want to know "how does this help me" not "what did they say for 90 minutes."
157+
Focus analysis on practical application rather than comprehensive summaries. Users want
158+
to know "how does this help me" not "what did they say for 90 minutes."
158159

159160
Extract concrete examples and code patterns when available. Reference specific
160161
timestamps so users can jump to relevant sections.
161162

162-
When comparing with project code, be specific about similarities and differences.
163-
Vague comparisons like "similar approach" don't add value.
163+
When comparing with project code, be specific about similarities and differences. Vague
164+
comparisons like "similar approach" don't add value.
164165

165166
For technical content, identify the underlying patterns and principles rather than
166167
surface-level implementation details. Help users understand transferable concepts.

0 commit comments

Comments
 (0)