-
Notifications
You must be signed in to change notification settings - Fork 24.8k
Add article-freshness-review prompt file #36914
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.
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
Closed
Closed
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
9dd8edb
Initial plan
Copilot cc2ad55
Add article-freshness-review prompt file
Copilot 18c0894
Revise description for article freshness review prompt
wadepickett 8e5a73b
Update article-freshness-review prompt metadata
wadepickett b6eb1b3
Add Copilot Feasibility Assessment section
wadepickett 1bcde40
Update metadata field check instructions
wadepickett 9aacb6e
Update article freshness review prompt
wadepickett a62c293
Apply suggestions from code review
wadepickett File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| --- | ||
| author: wpickett | ||
| description: > | ||
| Generates a freshness review report for an ASP.NET Core doc article. | ||
| Usage: Open a GitHub issue, open Copilot Chat, and paste: | ||
| "Read and follow all instructions in .github/prompts/article-freshness-review.prompt.md. | ||
| Use this issue as context. Generate the freshness review report." | ||
| Then copy the report into the issue discussion. Does NOT create a PR. | ||
| ms.author: wpickett | ||
| ms.date: 03/24/2026 | ||
| --- | ||
|
|
||
| # ASP.NET Core Article Freshness Review | ||
|
|
||
| > **Usage**: Attach this prompt file in Copilot Chat, then type the article URL | ||
| > (e.g., `Review https://learn.microsoft.com/aspnet/core/web-api/action-return-types`). | ||
| > Paste the resulting report into the GitHub issue discussion. | ||
| > **This prompt does NOT create a PR or modify any files.** | ||
|
|
||
| ## Instructions | ||
|
|
||
| You are reviewing an ASP.NET Core documentation article for freshness and accuracy. | ||
|
|
||
| ### Step 1: Load Context | ||
|
|
||
| Read the repository's copilot instruction file for conventions and rules: | ||
| [copilot-instructions.md](../copilot-instructions.md) | ||
|
|
||
| And read the dotnet/docs repository editing instructions: | ||
| https://raw.githubusercontent.com/dotnet/docs/refs/heads/main/.github/agents/docseditor.agent.md | ||
|
|
||
| ### Step 2: Review the Article | ||
|
|
||
| Review the article provided by the user. | ||
|
|
||
| Evaluate it against ALL of the following criteria: | ||
|
|
||
| **A. Moniker Range & Versioning** | ||
| * Are there newer APIs, packages, or approaches that supersede what the article describes? | ||
| * If so: Is the monikerRange in the frontmatter still appropriate? | ||
| * If the article covers a version that is no longer the latest, does it include guidance directing readers to the current version's documentation? | ||
|
|
||
| **B. Frontmatter & Metadata** | ||
| * Is ms.date in MM/DD/YYYY format? | ||
| * Is the title field listed first, with remaining fields in alphabetical order? | ||
| * Are all required metadata fields present? | ||
|
|
||
| **C. Content Accuracy** | ||
| * Are code samples correct for the targeted framework version(s)? | ||
| * Are NuGet package names and namespaces still valid? | ||
| * Are referenced APIs still available and not deprecated in the targeted version? | ||
| * Do xref links (xref:) resolve to valid UIDs? | ||
|
|
||
| **D. Style & Conventions (per copilot-instructions.md)** | ||
| * Placeholders in code/commands use {UPPER CASE WITH SPACES} format with descriptions in surrounding text. | ||
| * Section headers do NOT end with periods. | ||
| * Bullet markers use * (not -). | ||
| * Links follow the documented conventions (relative for MS Learn, full URL for external). | ||
| * Code blocks use :::code snippet references where appropriate. | ||
|
|
||
| **E. External Links** | ||
| * Are external URLs likely still valid? (Flag any that point to known-sunset services or archived repos.) | ||
|
|
||
| ### Step 3: Produce the Report | ||
|
|
||
| Output a single Markdown report with this EXACT structure: | ||
|
|
||
| ``` | ||
| # Freshness Review Report | ||
|
|
||
| **File:** `{FILE PATH}` | ||
| **Repository:** `dotnet/AspNetCore.Docs` | ||
| **Reviewed:** {REVIEW DATE} | ||
| **Reviewer:** @{REVIEWER} | ||
| **Article URL:** {ARTICLE URL} | ||
| **Source URL:** {SOURCE URL} | ||
|
|
||
| --- | ||
|
|
||
| ## Verdict: **{Needs Updating | Current — No Changes Needed}** | ||
|
|
||
| A verdict of "Needs Updating" requires at least one Critical or Moderate issue. | ||
|
|
||
| --- | ||
|
|
||
| ## Critical Issues | ||
|
|
||
| {Issues that affect correctness, reader confusion, or discoverability. | ||
| Each issue should include: | ||
| - **Issue title** | ||
| - **Location:** file path and line number(s) | ||
| - **Current content:** (quoted) | ||
| - **Recommended fix:** (exact replacement text) | ||
| - **Rationale:** why this matters} | ||
|
|
||
| ## Moderate Issues | ||
|
|
||
| {Issues that affect style compliance or minor accuracy. | ||
| Same sub-structure as Critical.} | ||
|
|
||
| ## Minor Issues | ||
|
|
||
| {Cosmetic or convention-based issues. | ||
| Same sub-structure as Critical.} | ||
|
|
||
| --- | ||
|
|
||
| ## Summary of Recommended Changes | ||
|
|
||
| {A numbered checklist of ALL changes, in order of priority, that can be | ||
| used directly as a task list for the PR author.} | ||
| ``` | ||
|
|
||
| ## Rules | ||
|
|
||
| * Do NOT invent issues. If something is correct, say so. | ||
| * Do NOT suggest changes outside the scope of the copilot-instructions.md rules and current ASP.NET Core documentation standards. | ||
| * If recommending a NOTE or callout, provide the EXACT Markdown to insert including moniker-range fencing if applicable. | ||
| * Flag the issue title if it doesn't match the actual file name or path. | ||
| * Every recommended change must include the exact "before" and "after" text. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.