dotnet-documentation-strategy

Compare Starlight, Docusaurus, and DocFX for .NET documentation tooling.

71|10|Updated Feb 11, 2026
One-click install
npx skills add https://github.com/wshaddix/dotnet-skills --skill dotnet-documentation-strategy-wshaddix
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-documentation-strategy
Source: https://github.com/wshaddix/dotnet-skills/tree/main/skills/dotnet-documentation-strategy
Command: npx skills add https://github.com/wshaddix/dotnet-skills --skill dotnet-documentation-strategy-wshaddix

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you select the most appropriate documentation tooling for your .NET project, ensuring your documentation is maintainable, discoverable, and aligned with your team's needs.

Core Features & Use Cases

  • Tooling Comparison: Evaluates Starlight, Docusaurus, and DocFX based on project type, team size, and ecosystem.
  • Decision Tree: Provides a clear flowchart to guide your selection process.
  • MarkdownSnippets Integration: Explains how to keep code examples in sync with source code.
  • Mermaid Support: Details how to render diagrams across different platforms.
  • Use Case: You're starting a new .NET library and need to decide between Starlight and DocFX for your documentation. This Skill will guide you through the decision based on your team's familiarity with React and your need for API reference generation.

Quick Start

Use the dotnet-documentation-strategy skill to get a recommendation for documenting a new .NET MAUI application.

Frequently Asked Questions about dotnet-documentation-strategy

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

FAQPage Schema
What is the best way to choose a .NET documentation tool?

Choosing a .NET documentation tool involves comparing Starlight, Docusaurus, and DocFX based on project context, team expertise, and API reference requirements. A decision tree evaluates team React familiarity and ecosystem alignment.

How do I keep .NET documentation code snippets in sync with source code?

To keep .NET documentation code snippets in sync, integrate MarkdownSnippets into your workflow. This verifies that code examples remain accurate and synchronized directly with your source code across Starlight, Docusaurus, or DocFX.

Starlight vs DocFX: which documentation tool should I use for a .NET library?

Choosing between Starlight and DocFX for a .NET library depends on your need for native API reference generation versus team familiarity with React. Starlight offers modern UI, while DocFX handles .NET API extraction.

Does Docusaurus support Mermaid diagram rendering for .NET projects?

Docusaurus supports Mermaid diagram rendering for .NET projects. This Skill details how to configure Mermaid across different platforms, including Docusaurus, to visualize architecture and workflows effectively.

Can I migrate existing .NET documentation between Docusaurus and Starlight?

You can migrate existing .NET documentation between Docusaurus and Starlight. This Skill addresses migration paths and common agent pitfalls, ensuring a smooth transition while maintaining Mermaid and MarkdownSnippets integration.