Skip to content

DEVED-14117: Rename ECA prompt for consistency and update PR template #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
farah-aly wants to merge 2 commits into
base: main
Choose a base branch
from
Open

DEVED-14117: Rename ECA prompt for consistency and update PR template #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8739e82
Rename for consistency
farah-aly Aug 7, 2026
cdbee16
Update PR template
farah-aly Aug 7, 2026
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
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Please select the options that are relevant:
- [ ] Generate Alt Text prompt
- [ ] Auto Edit Document prompt
- [ ] Generate Metadata prompt
- [ ] Update the Error Code Documentation prompt

## Testing checklist

Expand Down
8 changes: 4 additions & 4 deletions prompts/error-code-assistant.mdx → prompts/update-error-code-documentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Error Code Assistant"
title: "Update the Error Code Documentation"
description: "Edits and completes error code documentation pages with accurate frontmatter and structured content"
version: "1.0.0"
variables:
Expand All @@ -25,9 +25,9 @@ metadata:
- "structured-content"
---

# Error Code Assistant Prompt
# Update the Error Code Documentation Prompt

This document provides an overview of the "Error Code Assistant" prompt, designed to edit and update error code documentation pages. It ensures all frontmatter fields and content sections are complete, accurate, and written in a direct, instructional voice. Contributors can use this guide to understand the prompt's functionality and suggest improvements.
This document provides an overview of the "Update the Error Code Documentation" prompt, designed to edit and update error code documentation pages. It ensures all frontmatter fields and content sections are complete, accurate, and written in a direct, instructional voice. Contributors can use this guide to understand the prompt's functionality and suggest improvements.

## Prerequisites

Expand All @@ -50,7 +50,7 @@ See the [Configuration Guide](#configuration-guide) below for detailed instructi

## Prompt Overview

The Error Code Assistant reviews error code MDX pages, fills in missing or empty frontmatter fields, validates content against approved sources, and outputs a complete, structured error code page.
The "Update the Error Code Documentation" prompt reviews error code MDX pages, fills in missing or empty frontmatter fields, validates content against approved sources, and outputs a complete, structured error code page.

## Prompt

Expand Down