wtf-p 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +338 -0
- package/bin/install.js +358 -0
- package/bin/uninstall.js +485 -0
- package/commands/wtfp/analyze-bib.md +326 -0
- package/commands/wtfp/check-refs.md +205 -0
- package/commands/wtfp/create-outline.md +275 -0
- package/commands/wtfp/discuss-section.md +71 -0
- package/commands/wtfp/export-latex.md +216 -0
- package/commands/wtfp/help.md +342 -0
- package/commands/wtfp/insert-section.md +130 -0
- package/commands/wtfp/list-assumptions.md +109 -0
- package/commands/wtfp/map-project.md +197 -0
- package/commands/wtfp/new-paper.md +443 -0
- package/commands/wtfp/pause-writing.md +145 -0
- package/commands/wtfp/plan-revision.md +180 -0
- package/commands/wtfp/plan-section.md +247 -0
- package/commands/wtfp/polish-prose.md +177 -0
- package/commands/wtfp/progress.md +325 -0
- package/commands/wtfp/remove-section.md +147 -0
- package/commands/wtfp/research-gap.md +235 -0
- package/commands/wtfp/resume-writing.md +142 -0
- package/commands/wtfp/review-section.md +409 -0
- package/commands/wtfp/submit-milestone.md +211 -0
- package/commands/wtfp/write-section.md +273 -0
- package/package.json +40 -0
- package/write-the-f-paper/references/checkpoints.md +213 -0
- package/write-the-f-paper/references/continuation-format.md +223 -0
- package/write-the-f-paper/references/git-integration.md +241 -0
- package/write-the-f-paper/references/imrad-structure.md +212 -0
- package/write-the-f-paper/references/length-estimation.md +148 -0
- package/write-the-f-paper/references/plan-format.md +361 -0
- package/write-the-f-paper/references/principles.md +158 -0
- package/write-the-f-paper/references/questioning.md +132 -0
- package/write-the-f-paper/references/research-pitfalls.md +208 -0
- package/write-the-f-paper/templates/config.json +30 -0
- package/write-the-f-paper/templates/context.md +179 -0
- package/write-the-f-paper/templates/continue-here.md +142 -0
- package/write-the-f-paper/templates/data-inventory.md +142 -0
- package/write-the-f-paper/templates/discovery.md +146 -0
- package/write-the-f-paper/templates/issues.md +59 -0
- package/write-the-f-paper/templates/manuscript.md +253 -0
- package/write-the-f-paper/templates/narrative-arc.md +227 -0
- package/write-the-f-paper/templates/outline.md +274 -0
- package/write-the-f-paper/templates/phase-prompt.md +348 -0
- package/write-the-f-paper/templates/prior-drafts.md +204 -0
- package/write-the-f-paper/templates/project-context/argument-structure.md +267 -0
- package/write-the-f-paper/templates/project-context/bibliography.md +152 -0
- package/write-the-f-paper/templates/project-context/gaps.md +122 -0
- package/write-the-f-paper/templates/project-context/imrad.md +140 -0
- package/write-the-f-paper/templates/project-context/peer-review.md +152 -0
- package/write-the-f-paper/templates/project-context/style-guide.md +198 -0
- package/write-the-f-paper/templates/project-context/tools.md +170 -0
- package/write-the-f-paper/templates/project.md +185 -0
- package/write-the-f-paper/templates/research.md +384 -0
- package/write-the-f-paper/templates/review-comments.md +253 -0
- package/write-the-f-paper/templates/revision-issues.md +169 -0
- package/write-the-f-paper/templates/roadmap.md +187 -0
- package/write-the-f-paper/templates/section-archive.md +178 -0
- package/write-the-f-paper/templates/section-context.md +114 -0
- package/write-the-f-paper/templates/section.md +128 -0
- package/write-the-f-paper/templates/state.md +244 -0
- package/write-the-f-paper/templates/summary.md +277 -0
- package/write-the-f-paper/venues/acm-cs.yaml +102 -0
- package/write-the-f-paper/venues/arxiv-ml.yaml +103 -0
- package/write-the-f-paper/venues/ieee-cs.yaml +100 -0
- package/write-the-f-paper/venues/nature.yaml +81 -0
- package/write-the-f-paper/venues/thesis-chapter.yaml +101 -0
- package/write-the-f-paper/workflows/create-outline.md +462 -0
- package/write-the-f-paper/workflows/create-outline.wcn.md +194 -0
- package/write-the-f-paper/workflows/discuss-section.md +249 -0
- package/write-the-f-paper/workflows/discuss-section.wcn.md +63 -0
- package/write-the-f-paper/workflows/execute-section.md +704 -0
- package/write-the-f-paper/workflows/execute-section.wcn.md +219 -0
- package/write-the-f-paper/workflows/list-assumptions.md +183 -0
- package/write-the-f-paper/workflows/list-assumptions.wcn.md +42 -0
- package/write-the-f-paper/workflows/lit-review-phase.md +281 -0
- package/write-the-f-paper/workflows/lit-review-phase.wcn.md +92 -0
- package/write-the-f-paper/workflows/map-project.md +359 -0
- package/write-the-f-paper/workflows/map-project.wcn.md +73 -0
- package/write-the-f-paper/workflows/plan-section.md +409 -0
- package/write-the-f-paper/workflows/plan-section.wcn.md +236 -0
- package/write-the-f-paper/workflows/research-gap.md +469 -0
- package/write-the-f-paper/workflows/research-gap.wcn.md +119 -0
- package/write-the-f-paper/workflows/resume-paper.md +274 -0
- package/write-the-f-paper/workflows/resume-paper.wcn.md +93 -0
- package/write-the-f-paper/workflows/review-section.md +329 -0
- package/write-the-f-paper/workflows/review-section.wcn.md +91 -0
- package/write-the-f-paper/workflows/submit-draft.md +368 -0
- package/write-the-f-paper/workflows/submit-draft.wcn.md +69 -0
- package/write-the-f-paper/workflows/transition.md +375 -0
- package/write-the-f-paper/workflows/transition.wcn.md +113 -0
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wtfp:research-gap
|
|
3
|
+
description: Comprehensive literature/domain research for a section
|
|
4
|
+
argument-hint: "[section]"
|
|
5
|
+
allowed-tools:
|
|
6
|
+
- Read
|
|
7
|
+
- Bash
|
|
8
|
+
- Write
|
|
9
|
+
- WebFetch
|
|
10
|
+
- WebSearch
|
|
11
|
+
- mcp__context7__*
|
|
12
|
+
- AskUserQuestion
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
<objective>
|
|
16
|
+
Perform comprehensive literature/domain research for a specific section.
|
|
17
|
+
|
|
18
|
+
Discovers:
|
|
19
|
+
- Key citations needed
|
|
20
|
+
- Standard approaches in the literature
|
|
21
|
+
- Gaps in current research
|
|
22
|
+
- How experts write about this topic
|
|
23
|
+
|
|
24
|
+
Creates RESEARCH.md with "how experts write this" knowledge.
|
|
25
|
+
|
|
26
|
+
Use for literature reviews, methodology justification, positioning your contribution.
|
|
27
|
+
</objective>
|
|
28
|
+
|
|
29
|
+
<execution_context>
|
|
30
|
+
@~/.claude/write-the-f-paper/workflows/research-gap.md
|
|
31
|
+
@~/.claude/write-the-f-paper/references/research-pitfalls.md
|
|
32
|
+
</execution_context>
|
|
33
|
+
|
|
34
|
+
<process>
|
|
35
|
+
|
|
36
|
+
<step name="verify">
|
|
37
|
+
**Verify project exists:**
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
[ ! -f .planning/PROJECT.md ] && echo "ERROR: No project found. Run /wtfp:new-paper first" && exit 1
|
|
41
|
+
[ ! -f .planning/ROADMAP.md ] && echo "ERROR: No outline found. Run /wtfp:create-outline first" && exit 1
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
</step>
|
|
45
|
+
|
|
46
|
+
<step name="load">
|
|
47
|
+
**Load context:**
|
|
48
|
+
|
|
49
|
+
- Read PROJECT.md for core argument and field
|
|
50
|
+
- Read ROADMAP.md for section goal
|
|
51
|
+
- Read argument-map.md for claims to support
|
|
52
|
+
- Read sources/literature.md for existing citations
|
|
53
|
+
</step>
|
|
54
|
+
|
|
55
|
+
<step name="scope">
|
|
56
|
+
**Define research scope:**
|
|
57
|
+
|
|
58
|
+
Use AskUserQuestion:
|
|
59
|
+
- header: "Research Focus"
|
|
60
|
+
- question: "What specifically do you need to understand for [section]?"
|
|
61
|
+
- options:
|
|
62
|
+
- "Key citations" — Who are the must-cite authors/papers?
|
|
63
|
+
- "Methodology" — How do others approach this method?
|
|
64
|
+
- "State of field" — What's the current consensus/debate?
|
|
65
|
+
- "Positioning" — How to differentiate from existing work?
|
|
66
|
+
- "All of the above" — Comprehensive research
|
|
67
|
+
|
|
68
|
+
</step>
|
|
69
|
+
|
|
70
|
+
<step name="research">
|
|
71
|
+
**Conduct research:**
|
|
72
|
+
|
|
73
|
+
Based on scope, investigate:
|
|
74
|
+
|
|
75
|
+
**Key Citations:**
|
|
76
|
+
- Identify foundational papers
|
|
77
|
+
- Find recent high-impact work
|
|
78
|
+
- Note methodological papers
|
|
79
|
+
- Track disagreements/debates
|
|
80
|
+
|
|
81
|
+
**Standard Approaches:**
|
|
82
|
+
- How do others structure similar sections?
|
|
83
|
+
- What's the typical argument flow?
|
|
84
|
+
- What evidence is typically presented?
|
|
85
|
+
|
|
86
|
+
**Gaps:**
|
|
87
|
+
- What's missing in current literature?
|
|
88
|
+
- Where does your work fit?
|
|
89
|
+
- What questions remain unanswered?
|
|
90
|
+
|
|
91
|
+
**Expert Writing Patterns:**
|
|
92
|
+
- How do top papers in this area write about this?
|
|
93
|
+
- What terminology is standard?
|
|
94
|
+
- What level of detail is expected?
|
|
95
|
+
|
|
96
|
+
</step>
|
|
97
|
+
|
|
98
|
+
<step name="create_research">
|
|
99
|
+
**Create RESEARCH.md:**
|
|
100
|
+
|
|
101
|
+
```markdown
|
|
102
|
+
---
|
|
103
|
+
section: XX-name
|
|
104
|
+
scope: [research scope]
|
|
105
|
+
confidence: [high/medium/low]
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
# Research: [Section Name]
|
|
109
|
+
|
|
110
|
+
## Summary
|
|
111
|
+
[2-3 sentence overview of findings]
|
|
112
|
+
|
|
113
|
+
## Key Citations
|
|
114
|
+
|
|
115
|
+
### Foundational
|
|
116
|
+
| Citation | Contribution | Relevance |
|
|
117
|
+
|----------|--------------|-----------|
|
|
118
|
+
| [Author (Year)] | [What they established] | [Why cite] |
|
|
119
|
+
|
|
120
|
+
### Recent/High-Impact
|
|
121
|
+
| Citation | Contribution | Relevance |
|
|
122
|
+
|----------|--------------|-----------|
|
|
123
|
+
|
|
124
|
+
### Methodology
|
|
125
|
+
| Citation | Approach | Relevance |
|
|
126
|
+
|----------|----------|-----------|
|
|
127
|
+
|
|
128
|
+
## Standard Approaches
|
|
129
|
+
[How others write about this topic]
|
|
130
|
+
|
|
131
|
+
- Typical structure: [...]
|
|
132
|
+
- Common arguments: [...]
|
|
133
|
+
- Expected evidence: [...]
|
|
134
|
+
|
|
135
|
+
## Field Consensus
|
|
136
|
+
[What's generally agreed upon]
|
|
137
|
+
|
|
138
|
+
## Active Debates
|
|
139
|
+
[Where experts disagree]
|
|
140
|
+
|
|
141
|
+
## Gaps in Literature
|
|
142
|
+
- [Gap 1]: [your opportunity]
|
|
143
|
+
- [Gap 2]: [your opportunity]
|
|
144
|
+
|
|
145
|
+
## Your Positioning
|
|
146
|
+
[How your work relates to existing literature]
|
|
147
|
+
|
|
148
|
+
## Writing Recommendations
|
|
149
|
+
- Terminology to use: [...]
|
|
150
|
+
- Level of detail expected: [...]
|
|
151
|
+
- Citations to definitely include: [...]
|
|
152
|
+
- Arguments to make: [...]
|
|
153
|
+
|
|
154
|
+
## Sources Consulted
|
|
155
|
+
- [Source 1]
|
|
156
|
+
- [Source 2]
|
|
157
|
+
|
|
158
|
+
## Confidence Assessment
|
|
159
|
+
- Key citations: [high/medium/low]
|
|
160
|
+
- Field understanding: [high/medium/low]
|
|
161
|
+
- Gap identification: [high/medium/low]
|
|
162
|
+
|
|
163
|
+
## Open Questions
|
|
164
|
+
- [Questions that need user input]
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
*Researched: [date]*
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
</step>
|
|
171
|
+
|
|
172
|
+
<step name="update_literature">
|
|
173
|
+
**Update literature index:**
|
|
174
|
+
|
|
175
|
+
Add any new citations discovered to `.planning/sources/literature.md`.
|
|
176
|
+
|
|
177
|
+
</step>
|
|
178
|
+
|
|
179
|
+
<step name="commit">
|
|
180
|
+
```bash
|
|
181
|
+
git add .planning/sections/XX-name/XX-RESEARCH.md .planning/sources/literature.md
|
|
182
|
+
git commit -m "$(cat <<'EOF'
|
|
183
|
+
research(XX): [section name] literature review
|
|
184
|
+
|
|
185
|
+
Scope: [scope]
|
|
186
|
+
Citations found: [N]
|
|
187
|
+
Confidence: [level]
|
|
188
|
+
EOF
|
|
189
|
+
)"
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
</step>
|
|
193
|
+
|
|
194
|
+
<step name="done">
|
|
195
|
+
**Present completion:**
|
|
196
|
+
|
|
197
|
+
```
|
|
198
|
+
Research complete:
|
|
199
|
+
|
|
200
|
+
- Research: .planning/sections/XX-name/XX-RESEARCH.md
|
|
201
|
+
- Citations added: [N] new references
|
|
202
|
+
- Confidence: [level]
|
|
203
|
+
|
|
204
|
+
## Key Findings
|
|
205
|
+
[2-3 bullet summary]
|
|
206
|
+
|
|
207
|
+
## Recommended Next Steps
|
|
208
|
+
[Based on research]
|
|
209
|
+
|
|
210
|
+
---
|
|
211
|
+
|
|
212
|
+
## ▶ Next Up
|
|
213
|
+
|
|
214
|
+
**Plan section** — create writing plan with research context
|
|
215
|
+
|
|
216
|
+
`/wtfp:plan-section [section]`
|
|
217
|
+
|
|
218
|
+
<sub>`/clear` first → fresh context window</sub>
|
|
219
|
+
|
|
220
|
+
---
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
</step>
|
|
224
|
+
|
|
225
|
+
</process>
|
|
226
|
+
|
|
227
|
+
<success_criteria>
|
|
228
|
+
- [ ] Research scope defined with user
|
|
229
|
+
- [ ] Key citations identified
|
|
230
|
+
- [ ] Standard approaches documented
|
|
231
|
+
- [ ] Gaps identified
|
|
232
|
+
- [ ] Writing recommendations provided
|
|
233
|
+
- [ ] literature.md updated
|
|
234
|
+
- [ ] All committed to git
|
|
235
|
+
</success_criteria>
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wtfp:resume-writing
|
|
3
|
+
description: Resume work from previous session with full context restoration
|
|
4
|
+
allowed-tools:
|
|
5
|
+
- Read
|
|
6
|
+
- Bash
|
|
7
|
+
- Glob
|
|
8
|
+
- SlashCommand
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
<objective>
|
|
12
|
+
Resume work from a previous session with full context restoration.
|
|
13
|
+
|
|
14
|
+
Reads STATE.md and any .continue-here.md files to restore context.
|
|
15
|
+
|
|
16
|
+
Shows current position, recent progress, and offers appropriate next actions.
|
|
17
|
+
</objective>
|
|
18
|
+
|
|
19
|
+
<process>
|
|
20
|
+
|
|
21
|
+
<step name="verify">
|
|
22
|
+
**Verify project exists:**
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
[ ! -f .planning/STATE.md ] && echo "ERROR: No project state found. Run /wtfp:new-paper first" && exit 1
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
</step>
|
|
29
|
+
|
|
30
|
+
<step name="load">
|
|
31
|
+
**Load project context:**
|
|
32
|
+
|
|
33
|
+
- Read STATE.md for current position and session info
|
|
34
|
+
- Read PROJECT.md for paper vision
|
|
35
|
+
- Read ROADMAP.md for section structure
|
|
36
|
+
- Check for .continue-here.md files in section directories
|
|
37
|
+
</step>
|
|
38
|
+
|
|
39
|
+
<step name="check_handoff">
|
|
40
|
+
**Check for handoff file:**
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
find .planning/sections -name ".continue-here.md" 2>/dev/null | head -1
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
If handoff file exists:
|
|
47
|
+
- Read it for detailed resumption context
|
|
48
|
+
- Extract: current task, remaining work, next action, blockers
|
|
49
|
+
</step>
|
|
50
|
+
|
|
51
|
+
<step name="present">
|
|
52
|
+
**Present resumption context:**
|
|
53
|
+
|
|
54
|
+
**If handoff file exists:**
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
# Resuming: [Paper Title]
|
|
58
|
+
|
|
59
|
+
## Where You Left Off
|
|
60
|
+
Section [N]: [Name]
|
|
61
|
+
Task [X] of [Y]: [task description]
|
|
62
|
+
Status: [in_progress/blocked]
|
|
63
|
+
|
|
64
|
+
## Completed in Last Session
|
|
65
|
+
- [Task 1]: [done]
|
|
66
|
+
- [Task 2]: [done]
|
|
67
|
+
|
|
68
|
+
## Remaining Work
|
|
69
|
+
- [Current task]: [in progress]
|
|
70
|
+
- [Next tasks]: [pending]
|
|
71
|
+
|
|
72
|
+
## Context Notes
|
|
73
|
+
[Notes from .continue-here.md]
|
|
74
|
+
|
|
75
|
+
## Blockers (if any)
|
|
76
|
+
[Any blockers noted]
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## ▶ Next Action
|
|
81
|
+
|
|
82
|
+
[From .continue-here.md next_action]
|
|
83
|
+
|
|
84
|
+
`/wtfp:[appropriate-command]`
|
|
85
|
+
|
|
86
|
+
<sub>`/clear` first if context window is full</sub>
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
**If no handoff file:**
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
# Resuming: [Paper Title]
|
|
95
|
+
|
|
96
|
+
## Current Position
|
|
97
|
+
Section [N] of [total]: [Name]
|
|
98
|
+
Plan [X] of [section-total]: [status]
|
|
99
|
+
Words: [current] / [target]
|
|
100
|
+
|
|
101
|
+
## Recent Progress
|
|
102
|
+
[From STATE.md or recent SUMMARY files]
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## ▶ Next Up
|
|
107
|
+
|
|
108
|
+
[Based on STATE.md current position]
|
|
109
|
+
|
|
110
|
+
`/wtfp:[appropriate-command]`
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
For full status: `/wtfp:progress`
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
</step>
|
|
120
|
+
|
|
121
|
+
<step name="cleanup">
|
|
122
|
+
**Clean up handoff file after resume:**
|
|
123
|
+
|
|
124
|
+
If user proceeds with next action, the handoff file should be removed:
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
rm .planning/sections/XX-name/.continue-here.md
|
|
128
|
+
git add .planning/sections/XX-name/
|
|
129
|
+
git commit -m "docs: resume [section name] from handoff"
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
</step>
|
|
133
|
+
|
|
134
|
+
</process>
|
|
135
|
+
|
|
136
|
+
<success_criteria>
|
|
137
|
+
- [ ] STATE.md read for current position
|
|
138
|
+
- [ ] Handoff file detected if exists
|
|
139
|
+
- [ ] Full context presented
|
|
140
|
+
- [ ] Clear next action provided
|
|
141
|
+
- [ ] Routes to appropriate command
|
|
142
|
+
</success_criteria>
|