Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/instructions/dictation.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ lockfile
logger
logs
main
makefile
max-concurrency
max-turns
mcp
Expand Down Expand Up @@ -92,7 +91,6 @@ session
smoke
source
staged
starlight
step
steps
stop-after
Expand Down
14 changes: 9 additions & 5 deletions .github/workflows/dictation-prompt.lock.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 9 additions & 5 deletions .github/workflows/dictation-prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ Extract a comprehensive glossary of terms specific to this project from document

```bash
# Scan documentation markdown files for technical terms
find docs -name "*.md" -type f -exec grep -hoE '\b[a-z][a-z0-9_-]{2,}\b' {} + | sort -u | head -200
find docs/src/content/docs -name "*.md" -type f -exec grep -hoE '\b[a-z][a-z0-9_-]{2,}\b' {} + | sort -u | head -200

# Extract headings from documentation
find docs -name "*.md" -type f -exec grep -h "^#" {} + | sed 's/^#* //' | head -100
find docs/src/content/docs -name "*.md" -type f -exec grep -h "^#" {} + | sed 's/^#* //' | head -100

# Check key documentation files
cat docs/README.md docs/src/content/docs/reference/*.md | grep -oE '\b[a-z][a-z0-9_-]{3,}\b' | sort -u | head -150
cat docs/src/content/docs/reference/*.md | grep -oE '\b[a-z][a-z0-9_-]{3,}\b' | sort -u | head -150
```

**Extract terms from documentation covering:**
Expand All @@ -75,6 +75,8 @@ cat docs/README.md docs/src/content/docs/reference/*.md | grep -oE '\b[a-z][a-z0

**Goal**: Create a list of approximately 100 terms (95-105 is acceptable) that are most relevant to this project, extracted from documentation only.

**Exclude tooling-specific terms**: Do not include makefile, Astro, or starlight as these are tooling-specific and not user-facing concepts.

### 2. Create the Dictation Instructions File

Create the file `.github/instructions/dictation.instructions.md` with the following structure (NO EXAMPLES):
Expand Down Expand Up @@ -151,7 +153,8 @@ After creating the dictation instructions file:

## Important Guidelines

- **Extract from documentation**: Scan only docs/**.md files for terms
- **Extract from documentation**: Scan only docs/src/content/docs/**/*.md files for terms
- **Ignore tooling-specific terms**: Exclude makefile, Astro, and starlight (tooling-specific, not user-facing)
- **Be Thorough**: Scan all documentation files to extract accurate terms
- **Be Precise**: The glossary should contain approximately 100 terms (95-105 is acceptable)
- **Prioritize Relevance**: Include terms that are actually used frequently in documentation
Expand All @@ -166,7 +169,8 @@ After creating the dictation instructions file:
Your task is complete when:
1. ✅ The file `.github/instructions/dictation.instructions.md` exists
2. ✅ It contains approximately 100 project-specific terms in the glossary (95-105 is acceptable)
3. ✅ Terms are extracted from documentation files only (docs/**.md)
3. ✅ Terms are extracted from documentation files only (docs/src/content/docs/**/*.md)
4. ✅ Tooling-specific terms (makefile, Astro, starlight) are excluded
4. ✅ The rephrasing guidelines are clear and actionable
5. ✅ NO examples are included (keep it short)
6. ✅ File description removed and rephrased as a prompt
Expand Down
Loading