Conversation
Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com> Agent-Logs-Url: https://github.com/dotnet/AspNetCore.Docs/sessions/bffb0b74-2d76-417a-be74-7198e4a8f0cd
Updated the description for the article freshness review prompt to provide clearer usage instructions.
Added author and metadata for freshness review prompt.
Added a feasibility assessment section for Copilot handling of freshness updates, including justification and recommendations.
|
@tdykstra: Example report output so you can see what this generates. The prompt was applied to a random file I picked, in this case Freshness Review ReportFile: Verdict: Needs UpdatingA verdict of "Needs Updating" requires at least one Critical or Moderate issue. Critical Issues1. Outdated GitHub link to
|
|
@tdykstra see latest examples of output at the bottom of the discussions. |
Clarified the check for required metadata fields in the article freshness review prompt.
Added guidance for flagging old ms.date as Minor update.
|
@tdykstra, report output example after addressing metadata/frontmatter concerns:
Freshness Review ReportFile: Verdict: Needs UpdatingA verdict of "Needs Updating" requires at least one Critical or Moderate issue. Critical Issues1. The
|
Since tdykstra has added signficant suggestions for improvement, adding him to the author frontmatter value. Co-authored-by: Wade Pickett <wpickett@microsoft.com>
|
After some discussion about its helpfulness, we may not choose to use this prompt. I'll leave it here for a few days as we have time to think about it some more. Setting back to draft. |
Adds a manually-invoked Copilot Chat prompt for generating freshness review reports on ASP.NET Core documentation articles.
.github/prompts/article-freshness-review.prompt.md— a structured prompt that evaluates articles against moniker range/versioning, frontmatter/metadata, content accuracy, style conventions, and external link validity{UPPER CASE WITH SPACES})Usage for this prompt:
Original prompt
This section details on the original issue you should resolve
<issue_title>AI prompt: Article freshness review report</issue_title>
<issue_description>Create a standard prompt to use in this repo for determining if an article requires freshness work and then determine if the work required is someting GitHub Copilot could handle:
I am suggesting putting this in a .github/prompt directory. Those are only manually invoked as an opt-n, rather then auto-triggered.
Suggested pathname:
github/prompts/article-freshness-review.prompt.md
Suggested draft of the prompt below this line:
description: "Generates a freshness review report for an ASP.NET Core documentation article. Attach this prompt in Copilot Chat, then provide the article URL. The report is for posting in issue discussions — it does NOT create a PR."
ASP.NET Core Article Freshness Review
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
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
B. Frontmatter & Metadata
C. Content Accuracy
D. Style & Conventions (per copilot-instructions.md)
E. External Links
Step 3: Produce the Report
Output a single Markdown report with this EXACT structure:
Rules
<agent_instructions>The result should be a new prompt file:
github/prompts/article-freshness-review.prompt.md</agent_instructions>
Comments on the Issue (you are @copilot in this section)
📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.
Internal previews