Skip to content

Add API documentation skill and improve API reference docs#3387

Merged
mattleibow merged 5 commits intomainfrom
dev/doc-splits
Jan 21, 2026
Merged

Add API documentation skill and improve API reference docs#3387
mattleibow merged 5 commits intomainfrom
dev/doc-splits

Conversation

@mattleibow
Copy link
Collaborator

@mattleibow mattleibow commented Oct 17, 2025

Description of Change

This PR adds Copilot skills for documentation workflows and significantly improves public API reference documentation.

Copilot Skills (Repository Documentation)

  • api-docs skill: Guides AI assistants in writing and reviewing XML API documentation following .NET guidelines. Includes:
  • XML documentation patterns and syntax reference
  • Review checklist with severity classifications (Critical/Important/Minor)
  • Quick grep commands for finding common issues
  • XML validation workflows
  • skill-creator skill: Provides guidance for creating new Copilot skills

Public API Reference Documentation (docs submodule - 548 files)

  • Fixed spelling errors (e.g., "Represets" → "Represents")
  • Fixed invalid <paramref> references (e.g., buffer.buffer)
  • Added missing periods to summary, param, and returns tags
  • Added missing <see langword> tags for boolean values
  • Fixed empty parameter documentation
  • Updated framework indices for SkiaSharp 3.116/3.119, HarfBuzzSharp 8.3, MAUI, Skottie, SceneGraph, Resources
  • Removed obsolete 1.x framework indices

Bugs Fixed

None.

API Changes

None.

Behavioral Changes

None.

Required skia PR

None.

PR Checklist

  • Has tests (if omitted, state reason in description) - Documentation changes only
  • Rebased on top of main at time of PR
  • Merged related skia PRs
  • Changes adhere to coding standard

@github-actions
Copy link

Triage Summary

No labels will be applied as the issue lacks sufficient specific information necessary for categorization.

This issue is not a regression since it does not contain enough details to ascertain any previous working state or functionality.

Additional remarks:

  • The issue content primarily resembles a template and does not mention relevant areas like build issues or specific libraries (HarfBuzzSharp, SkiaSharp).
  • The description does not provide enough context regarding changes, bugs, or performance aspects, impairing accurate labeling.
  • There is no mention of the operating system or platform, making it impossible to categorize appropriately.
  • The lack of technical context or detailed information prevents any meaningful label assignment.
Detailed Summary and Actions

Summary of the triage:

  • No labels will be applied due to insufficient specific information regarding the issue.
  • The issue description resembles a template and lacks details on various potential categories.
  • There are no identifiable changes or problems that warrant a label assignment.

Summary of the actions that will be performed:

Action Item Description
No Action - Insufficient details prevent any action or categorization.

This entire triage process was automated by AI and mistakes may have been made. Please let us know so we can continue to improve.

@mattleibow mattleibow changed the title things Add API documentation skill and improve API reference docs Jan 21, 2026
@mattleibow mattleibow marked this pull request as ready for review January 21, 2026 23:29
@mattleibow mattleibow merged commit 57a105f into main Jan 21, 2026
1 of 2 checks passed
@mattleibow mattleibow deleted the dev/doc-splits branch January 21, 2026 23:30
@mattleibow mattleibow added the copilot Created by GitHub Copilot label Feb 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

copilot Created by GitHub Copilot

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant