documentation

Write MkDocs documentation for BlazorWebFormsComponents with templates and frontmatter structure.

450|78|Updated Dec 3, 2019
One-click install
npx skills add https://github.com/FritzAndFriends/BlazorWebFormsComponents --skill documentation-fritzandfriends
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/FritzAndFriends/BlazorWebFormsComponents/tree/main/.github/skills/documentation
Command: npx skills add https://github.com/FritzAndFriends/BlazorWebFormsComponents --skill documentation-fritzandfriends

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides developers to write MkDocs documentation for BlazorWebFormsComponents.

Core Features & Use Cases

  • Clear, consistent documentation templates for components, migrations, and utility features within the /docs folder.
  • Guidance on MkDocs configuration, navigation structure, and linking to Microsoft references and live samples.
  • Practical, copy-paste-ready examples for documentation patterns and style guidelines.

Quick Start

Use this skill to draft or review MkDocs documentation for a new component, migration guide, or utility feature in the /docs directory.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write MkDocs documentation for Blazor components?

To write MkDocs documentation for Blazor components, use a modular doc template enforcing consistent frontmatter with name and description fields, covering component docs, migration guides, and utility references within the /docs folder.

What is the required frontmatter structure for MkDocs component documentation?

The required MkDocs frontmatter structure mandates at least a name and description field. This consistent frontmatter pattern ensures standardized documentation metadata across all component docs, migration guides, and utility feature references.

How do I create a migration guide for BlazorWebFormsComponents?

To create a migration guide for BlazorWebFormsComponents, apply the provided documentation templates within the /docs folder, linking to Microsoft references and live samples while following the enforced style guidelines and navigation structure.

Can I use this documentation skill for utility feature references alongside component docs?

Yes, this documentation skill supports utility feature references alongside component documentation. It provides modular templates and style guidelines for both utility features and component docs within the /docs directory, ensuring consistent structure.

What's the best way to configure MkDocs navigation for Blazor documentation?

The best way to configure MkDocs navigation for Blazor documentation is to follow the recommended navigation and MkDocs configuration guidance provided, which structures component docs, migration guides, and utility references with links to Microsoft references and live samples.

Are there copy-paste-ready templates for Blazor component documentation?

Yes, the skill provides practical, copy-paste-ready examples for documentation patterns and style guidelines. These templates cover components, migrations, and utility features, ensuring consistent frontmatter and modular structure within the /docs folder.