Prompt file imported from jwikman/nab-al-tools (.github/prompts/finalizePullRequest.prompt.md). Copyright stays with the author.

Finalize Pull Request Documentation

Name: finalizePullRequest
Author: jwikman

Update all documentation for a pull request before merging, ensuring consistency across README.md, CHANGELOG.md, and the docs/ folder.

This prompt invokes the NAB-AL-Tools-Agent to systematically review and update all documentation following the Documentation Writing Guidelines.

What This Prompt Does

The agent will:

Review Changes: Analyze the pull request to identify all features, fixes, and changes
Update CHANGELOG.md: Add properly formatted entries under the appropriate version section
Update README.md: Add or update high-level feature descriptions, table of contents, and quick start information
Update/Create Documentation: Create or update detailed documentation in the docs/ folder following the established structure
Verify Consistency: Ensure terminology, formatting, and cross-references are consistent across all documentation
Validate Links: Check that all internal and external links work correctly
Review Examples: Ensure code examples are accurate and follow current API patterns

Usage Examples

/finalizePullRequest #123

/finalizePullRequest Add local glossary support

/finalizePullRequest Review and update docs before merge

Documentation Guidelines

The agent follows the comprehensive Documentation Writing Guidelines which cover:

Update Checklist: CHANGELOG.md format, README.md updates, docs/ folder structure, cross-file consistency, and quality checks
Documentation Structure: Feature docs, guides, reference material, and troubleshooting organization
Writing Style: Tone, terminology, formatting conventions, and content guidelines
Maintenance: When to update, update checklist, and cross-file consistency requirements

Refer to the instruction file for complete details on documentation standards and best practices.

When to Use This Prompt

Use this prompt:

✅ Before merging any pull request with user-facing changes
✅ After completing feature development
✅ When adding new settings or commands
✅ When fixing bugs that affect documented workflows
✅ When deprecating features or making breaking changes
✅ After adding Language Model Tools or MCP server features

Expected Output

The agent will provide:

Updated CHANGELOG.md with proper formatting and links
Updated README.md with high-level feature information
New/Updated docs/ with comprehensive feature documentation
Verification Report showing:
- What was updated and why
- Links checked and validated
- Code examples tested
- Cross-reference consistency verified
Suggested Improvements if any documentation gaps are identified

Tips for Best Results

Provide context about the changes (feature, bugfix, breaking change)
Reference the PR number or issue number for automatic analysis
Mention if specific documentation sections need extra attention
Point out any complex features that need detailed examples
Highlight any breaking changes that need migration guides

# Finalize Pull Request Documentation Update all documentation for a pull request before merging, ensuring consistency across README.md, CHANGELOG.md, and the docs/ folder. This prompt invokes the **NAB-AL-Tools-Agent** to systematically review and update all documentation following the **[Documentation Writing Guidelines](../instructions/documentation-writing.instructions.md)**. ## What This Prompt Does The agent will: 1. **Review Changes**: Analyze the pull request to identify all features, fixes, and changes 2. **Update CHANGELOG.md**: Add properly formatted entries under the appropriate version section 3. **Update README.md**: Add or update high-level feature descriptions, table of contents, and quick start information 4. **Update/Create Documentation**: Create or update detailed documentation in the `docs/` folder following the established structure 5. **Verify Consistency**: Ensure terminology, formatting, and cross-references are consistent across all documentation 6. **Validate Links**: Check that all internal and external links work correctly 7. **Review Examples**: Ensure code examples are accurate and follow current API patterns ## Usage Examples ``` /finalizePullRequest #123 ``` ``` /finalizePullRequest Add local glossary support ``` ``` /finalizePullRequest Review and update docs before merge ``` ## Documentation Guidelines The agent follows the comprehensive **[Documentation Writing Guidelines](../instructions/documentation-writing.instructions.md)** which cover: - **Update Checklist**: CHANGELOG.md format, README.md updates, docs/ folder structure, cross-file consistency, and quality checks - **Documentation Structure**: Feature docs, guides, reference material, and troubleshooting organization - **Writing Style**: Tone, terminology, formatting conventions, and content guidelines - **Maintenance**: When to update, update checklist, and cross-file consistency requirements Refer to the instruction file for complete details on documentation standards and best practices. ## When to Use This Prompt Use this prompt: - ✅ Before merging any pull request with user-facing changes - ✅ After completing feature development - ✅ When adding new settings or commands - ✅ When fixing bugs that affect documented workflows - ✅ When deprecating features or making breaking changes - ✅ After adding Language Model Tools or MCP server features ## Expected Output The agent will provide: 1. **Updated CHANGELOG.md** with proper formatting and links 2. **Updated README.md** with high-level feature information 3. **New/Updated docs/** with comprehensive feature documentation 4. **Verification Report** showing: - What was updated and why - Links checked and validated - Code examples tested - Cross-reference consistency verified 5. **Suggested Improvements** if any documentation gaps are identified ## Related Documentation - [Documentation Writing Guidelines](../instructions/documentation-writing.instructions.md) - [Coding Guidelines](../instructions/coding-guidelines.instructions.md) - [Agent Instructions](../copilot-instructions.md) ## Tips for Best Results - Provide context about the changes (feature, bugfix, breaking change) - Reference the PR number or issue number for automatic analysis - Mention if specific documentation sections need extra attention - Point out any complex features that need detailed examples - Highlight any breaking changes that need migration guides ---

{ "prompt": "# Finalize Pull Request Documentation\n\nUpdate all documentation for a pull request before merging, ensuring consistency across README.md, CHANGELOG.md, and the docs/ folder.\n\nThis prompt invokes the **NAB-AL-Tools-Agent** to systematically review and update all documentation following the **[Documentation Writing Guidelines](../instructions/documentation-writing.instructions.md)**.\n\n## What This Prompt Does\n\nThe agent will:\n\n1. **Review Changes**: Analyze the pull request to identify all features, fixes, and changes\n2. **Update CHANGELOG.md**: Add properly formatted entries under the appropriate version section\n3. **Update README.md**: Add or update high-level feature descriptions, table of contents, and quick start information\n4. **Update/Create Documentation**: Create or update detailed documentation in the `docs/` folder following the established structure\n5. **Verify Consistency**: Ensure terminology, formatting, and cross-references are consistent across all documentation\n6. **Validate Links**: Check that all internal and external links work correctly\n7. **Review Examples**: Ensure code examples are accurate and follow current API patterns\n\n## Usage Examples\n\n```\n/finalizePullRequest #123\n```\n\n```\n/finalizePullRequest Add local glossary support\n```\n\n```\n/finalizePullRequest Review and update docs before merge\n```\n\n## Documentation Guidelines\n\nThe agent follows the comprehensive **[Documentation Writing Guidelines](../instructions/documentation-writing.instructions.md)** which cover:\n\n- **Update Checklist**: CHANGELOG.md format, README.md updates, docs/ folder structure, cross-file consistency, and quality checks\n- **Documentation Structure**: Feature docs, guides, reference material, and troubleshooting organization\n- **Writing Style**: Tone, terminology, formatting conventions, and content guidelines\n- **Maintenance**: When to update, update checklist, and cross-file consistency requirements\n\nRefer to the instruction file for complete details on documentation standards and best practices.\n\n## When to Use This Prompt\n\nUse this prompt:\n\n- ✅ Before merging any pull request with user-facing changes\n- ✅ After completing feature development\n- ✅ When adding new settings or commands\n- ✅ When fixing bugs that affect documented workflows\n- ✅ When deprecating features or making breaking changes\n- ✅ After adding Language Model Tools or MCP server features\n\n## Expected Output\n\nThe agent will provide:\n\n1. **Updated CHANGELOG.md** with proper formatting and links\n2. **Updated README.md** with high-level feature information\n3. **New/Updated docs/** with comprehensive feature documentation\n4. **Verification Report** showing:\n - What was updated and why\n - Links checked and validated\n - Code examples tested\n - Cross-reference consistency verified\n5. **Suggested Improvements** if any documentation gaps are identified\n\n## Related Documentation\n\n- [Documentation Writing Guidelines](../instructions/documentation-writing.instructions.md)\n- [Coding Guidelines](../instructions/coding-guidelines.instructions.md)\n- [Agent Instructions](../copilot-instructions.md)\n\n## Tips for Best Results\n\n- Provide context about the changes (feature, bugfix, breaking change)\n- Reference the PR number or issue number for automatic analysis\n- Mention if specific documentation sections need extra attention\n- Point out any complex features that need detailed examples\n- Highlight any breaking changes that need migration guides\n\n---", "variables": [], "notes": "Finalize pull request documentation by updating README, CHANGELOG, and docs folder with comprehensive feature documentation. Arguments: [PR number, link or description].", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/jwikman/nab-al-tools", "path": ".github/prompts/finalizePullRequest.prompt.md", "ref": "16ad65d5fc0f4c5197871810c4ff6da1c167a23a", "url": "https://github.com/jwikman/nab-al-tools/blob/16ad65d5fc0f4c5197871810c4ff6da1c167a23a/.github/prompts/finalizePullRequest.prompt.md", "key": "jwikman/nab-al-tools/.github/prompts/finalizePullRequest.prompt.md" } } }

finalizePullRequest

About

Finalize Pull Request Documentation

What This Prompt Does

Usage Examples

Documentation Guidelines

When to Use This Prompt

Expected Output

Related Documentation

Tips for Best Results

Use it

Manifest

Reviews