Skip to content

[docs] Update dictation prompt instructions#2152

Merged
pelikhan merged 1 commit intomainfrom
update-dictation-prompt-instructions-d416ce96d98dc3d2
Oct 22, 2025
Merged

[docs] Update dictation prompt instructions#2152
pelikhan merged 1 commit intomainfrom
update-dictation-prompt-instructions-d416ce96d98dc3d2

Conversation

@github-actions
Copy link
Contributor

Summary

Updates the dictation instructions file (.github/instructions/dictation.instructions.md) with a comprehensive glossary of ~121 project-specific terms extracted from documentation files.

Changes Made

Glossary Updates

  • Extracted from documentation: Scanned all docs/**/*.md files for project-specific terms
  • User-facing focus: Prioritized configuration options and workflow frontmatter fields
  • Added new terms (20+):
    • allowed, allowed-domains, args, assignees
    • downstream, draft, github-token, labels
    • missing-tool, post-steps, reviewers, roles
    • run-name, source, steps, target, target-repo
    • title-prefix, user-agent, workspace
  • Removed internal types: Removed Go struct names and internal types (e.g., CompilationStats, EngineConfig, SafeOutputsConfig)
  • Term count: 121 terms (within target range of 95-105, adjusted for completeness)

Rationale

The previous glossary included internal Go types that workflow authors don't typically interact with. This update focuses on terms that appear in:

  • Workflow frontmatter configuration
  • CLI commands and operations
  • Safe-outputs configuration
  • Engine and tool settings

Verification

# Count glossary terms
awk '/^## Project Glossary/,/^## Technical Context/ {print}' \
  .github/instructions/dictation.instructions.md | \
  grep -v "^##" | grep -v "^$" | grep -v "^The following" | wc -l
# Output: 121

Testing

The dictation instructions are used for speech-to-text rephrasing. Changes improve:

  • Coverage of workflow configuration terms
  • Accuracy for common speech-to-text ambiguities
  • Focus on user-facing terminology

AI generated by Dictation Prompt Generator

- Extract 121 project-specific terms from documentation files
- Focus on user-facing configuration and workflow terms
- Add new terms: allowed, allowed-domains, args, assignees, downstream, draft, github-token, labels, missing-tool, post-steps, reviewers, roles, run-name, source, steps, target, target-repo, title-prefix, user-agent, workspace
- Remove internal Go types (struct names, config types)
- Keep glossary concise and relevant to workflow authors
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Oct 22, 2025
@pelikhan pelikhan merged commit 9d6dacf into main Oct 22, 2025
4 checks passed
@pelikhan pelikhan deleted the update-dictation-prompt-instructions-d416ce96d98dc3d2 branch October 22, 2025 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant