Skip to content

Update the audit-docs prompt #571

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

Merged
AlexJSully merged 2 commits into from
Jan 23, 2026
Merged

Update the audit-docs prompt #571

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
3ed737d
update docs again
AlexJSully Jan 23, 2026
e972ae7
Update .github/prompts/audit-docs.prompt.md
AlexJSully Jan 23, 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
14 changes: 12 additions & 2 deletions .github/prompts/audit-docs.prompt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ labels:

## Role & Purpose

Act as a **Strictly Factual Technical Auditor**. Your goal is to ensure the `docs/` directory is an objective, verifiable reflection of the current implementation in the #codebase.
Act as a **Strictly Factual Technical Writer and Auditor**. Your goal is to ensure the `docs/` directory is an objective, verifiable reflection of the current implementation in the #codebase.

**Your primary mandate is to write and correct documentation based on code reality.** Do not simply report on the state of documentation; perform the necessary updates to ensure the `docs/` directory perfectly matches the implementation found in the #codebase or #activePullRequest or #changes.

**Core Philosophy:**

Expand Down Expand Up @@ -40,7 +42,15 @@ Execute **Phase 1** and **Phase 2** in order.

1. **Phase 1: PR Sync (Priority)**
- **Condition:** If #activePullRequest or #changes exist.
- **Action:** Update `docs/` to reflect _only_ the immediate changes introduced by the PR.
- **Mandatory Interpretation:** This phase is a **documentation update step**, not a validation step.
- **Action (Required):**
- Treat the PR diff as the **source of truth**.
- Identify **code-level changes introduced by the PR** (new behavior, removed behavior, modified behavior).
- **Update `docs/` so that it accurately documents those changes**, even if:
- The PR did not touch any documentation files.
- Documentation already exists but is now incomplete or outdated.
- Do **NOT** conclude Phase 1 is complete simply because docs were untouched.
- **Scope Constraint:** Only document behavior that **changed as a direct result of the PR**.
- **Next:** Proceed immediately to Phase 2.

2. **Phase 2: General Audit (Mandatory)**
Expand Down
6 changes: 4 additions & 2 deletions .github/prompts/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

This directory contains AI-powered prompt templates designed for **GitHub Copilot's coding agent** to automate code review, documentation auditing, and quality improvements. These prompts integrate seamlessly with Visual Studio Code (VSCode) and GitHub's pull request workflow.

> [!CAUTION] ⚠️ CRITICAL: AI Accuracy Warning
> [!CAUTION]
> ⚠️ CRITICAL: AI Accuracy Warning
>
> **These prompts execute AI-driven code analysis and documentation generation. AI makes mistakes and hallucinations.** It is of utmost importance that you **carefully review all changes and output** before merging any PR. Do not blindly trust the AI's work. Verify that all suggested changes are:
>
Expand Down Expand Up @@ -107,7 +108,8 @@ targets:

## Important Safety Notes

> [!CAUTION] ⚠️ AI Makes Mistakes
> [!CAUTION]
> ⚠️ AI Makes Mistakes
>
> - **Hallucinations:** AI may invent function names, file paths, or code logic that don't exist
> - **Inaccuracies:** AI may misinterpret complex code or miss edge cases
Expand Down
Loading
Loading