api-docs

Create and validate XML API documentation for SkiaSharp per .NET guidelines.

5.5k|644|Updated Feb 22, 2016
One-click install
npx skills add https://github.com/mono/SkiaSharp --skill api-docs-mono
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/mono/SkiaSharp/tree/main/.github/skills/api-docs
Command: npx skills add https://github.com/mono/SkiaSharp --skill api-docs-mono

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

XML API documentation is essential for accessibility and maintainability; this skill provides a structured workflow to write and review SkiaSharp API docs in line with .NET guidelines.

Core Features & Use Cases

  • Create and validate XML documentation files for SkiaSharp types, members, and namespaces.
  • Review and edit docs to ensure consistency, proper <see> references, and compliance with Microsoft patterns.
  • Use the docs/SkiaSharpAPI directory to coordinate documentation across the SkiaSharp API surface.

Quick Start

Edit a type's XML doc in docs/SkiaSharpAPI, then run the validation and formatting workflow to ensure correctness.

Frequently Asked Questions about api-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write XML API documentation for SkiaSharp types and members?

To write XML API documentation for SkiaSharp, you create and edit XML doc files for types, namespaces, and members within the docs/SkiaSharpAPI directory. You then run validation workflows to enforce .NET formatting and cross-reference guidelines for consistency.

What is the best way to validate cross-references in SkiaSharp XML docs?

Validating cross-references in SkiaSharp XML docs involves running the skill's documented validation commands on your files in the docs/SkiaSharpAPI directory. This workflow checks XML syntax, formatting, and <see> references to ensure compliance with .NET guidelines.

Does this XML documentation workflow enforce .NET guidelines for SkiaSharp?

Yes, the workflow explicitly enforces .NET documentation guidelines for SkiaSharp. It reviews and edits your XML docs to ensure proper <see> references, consistent formatting, and compliance with established Microsoft patterns across the API surface.

Can I review and edit existing SkiaSharp API docs to fix formatting issues?

You can review and edit existing SkiaSharp API docs by modifying the XML files in docs/SkiaSharpAPI. Running the validation workflow afterwards identifies syntax errors and cross-reference issues, ensuring your edits align with .NET documentation patterns.

Why does my SkiaSharp XML documentation fail validation?

SkiaSharp XML documentation fails validation when files in docs/SkiaSharpAPI contain incorrect XML syntax, broken cross-references, or formatting that violates .NET guidelines. Running the validation command isolates these specific errors for correction.

When do I need to run validation commands for SkiaSharp API documentation?

You need to run validation commands for SkiaSharp API documentation after editing or creating XML files in docs/SkiaSharpAPI. This ensures your documentation maintains consistent syntax, valid cross-references, and compliance with .NET guidelines before integration.