Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 9, 2026

Addresses the need for a formal methodology to identify documentation gaps between dotnet/aspire APIs and aspire.dev coverage, enabling systematic issue creation for Copilot assignment.

Changes

Adds .github/prompts/documentation-coverage-audit.prompt.md with a 5-phase workflow:

  • Phase 1: API Discovery - Scripts and patterns to extract public APIs from dotnet/aspire (classes, interfaces, extension methods, resource types)
  • Phase 2: Documentation Audit - Inventory existing aspire.dev pages, extract documented API references via regex, cross-reference with integration-docs.json
  • Phase 3: Delta Analysis - Compare inventories, classify gaps by severity (High/Medium/Low), generate structured JSON report
  • Phase 4: Issue Generation - GitHub issue template with acceptance criteria for Copilot-assignable documentation tasks
  • Phase 5: Execution Workflow - Ready-to-run bash scripts for LLM/agent automation

Appendices

  • Package category mappings to expected doc locations
  • Documentation quality checklist
  • Known gap areas (extensibility, advanced networking, non-Azure deployments)
  • CI automation opportunities for coverage tracking

Follows existing .github/prompts/ convention alongside migrate-from-learn.prompt.md and update-integrations.prompt.md.

Original prompt

We've been developing really fast over in the dotnet/aspire repo and we've been accumlating a lot of docs debt in the microsoft/aspire.dev repo. I would really love for a formal plan to be created that brings us up to speed from the docs perspective. Our new https://aspire.dev site is great, but it lacks a full set coverage of all the features of dotnet/aspire. Please help me draft a plan that I could have an LLM or agent start working on to thoroughly evaluate ALL the APIs that exist within dotnet/aspire and then thoroughly examine the state of microsoft/aspire.dev and come up with a list of deltas. Theis list could feed into the creation of the plan, but each update could become an docs issue that we could later assign to Copilot.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits January 9, 2026 14:00
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Create a formal plan to address documentation debt Add documentation coverage audit plan for dotnet/aspire API gap analysis Jan 9, 2026
Copilot AI requested a review from IEvangelist January 9, 2026 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants