Skip to content

[docs] Update dictation skill instructions#7964

Merged
pelikhan merged 1 commit intomainfrom
update-dictation-skill-glossary-0de8c83dcbbee30c
Dec 28, 2025
Merged

[docs] Update dictation skill instructions#7964
pelikhan merged 1 commit intomainfrom
update-dictation-skill-glossary-0de8c83dcbbee30c

Conversation

@github-actions
Copy link
Contributor

Summary

Updated the dictation skill instructions (skills/dictation/SKILL.md) with a comprehensive glossary of project-specific technical terms extracted from the documentation.

Changes Made

Glossary Enhancement

  • Extracted 412 project-specific terms from docs/src/content/docs/**/*.md files
  • Organized alphabetically for easy reference
  • Focused on user-facing terms (excluded tooling-specific like makefile, Astro, starlight)

Documentation Sources

Scanned key documentation files including:

  • reference/glossary.md - Core concepts and definitions
  • reference/frontmatter.md - Configuration options
  • reference/tools.md - Tool configurations
  • reference/engines.md - AI engine options
  • reference/safe-outputs.md - Safe output types
  • reference/network.md - Network permissions
  • reference/safe-inputs.md - Custom tool definitions
  • setup/cli.md - CLI commands
  • reference/triggers.md - Workflow triggers

Speech-to-Text Error Corrections

  • Comprehensive mapping table for common misrecognitions
  • Spacing and hyphenation rules for compound terms
  • Preservation guidelines for YAML-specific syntax (underscores vs hyphens)
  • Context-aware corrections (e.g., "pull request" vs "pull-request" vs "pull_request")

Frontmatter Updates

  • Enhanced name field: "Dictation Instructions" (more descriptive)
  • Improved description field with project context
  • Added "Technical Context" section explaining gh-aw

Focus Guidelines

  • Clear instruction to NOT generate code examples
  • Clear instruction to NOT plan steps
  • Emphasis on fixing speech-to-text errors only

Success Criteria Met

✅ File skills/dictation/SKILL.md exists and updated
✅ Contains proper SKILL.md frontmatter (name, description)
✅ Contains 412 project-specific terms (within 240-460 acceptable range)
✅ Terms extracted from documentation only
✅ Focuses on fixing speech-to-text errors
✅ Pull request created with changes

Testing

The glossary was extracted by scanning documentation files and selecting the most frequently used project-specific terms. Terms were sorted alphabetically for easy lookup during dictation error correction.

AI generated by Dictation Prompt Generator

- Extracted 412 project-specific terms from docs/src/content/docs/
- Organized glossary alphabetically for easy reference
- Added comprehensive speech-to-text error corrections table
- Included spacing/hyphenation rules for common patterns
- Enhanced frontmatter metadata with proper name and description
- Added clear instructions to focus on error correction only
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Dec 28, 2025
@pelikhan pelikhan merged commit 54e5d94 into main Dec 28, 2025
4 checks passed
@pelikhan pelikhan deleted the update-dictation-skill-glossary-0de8c83dcbbee30c branch December 28, 2025 06:20
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