dotnet-documentation-strategy

Select documentation tooling for .NET projects among Starlight, Docusaurus, and DocFX.

Updated Aug 16, 2025
One-click install
npx skills add https://github.com/dodyg/blue-nile-pds --skill dotnet-documentation-strategy-dodyg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-documentation-strategy
Source: https://github.com/dodyg/blue-nile-pds/tree/main/.agents/skills/dotnet-documentation-strategy
Command: npx skills add https://github.com/dodyg/blue-nile-pds --skill dotnet-documentation-strategy-dodyg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It provides guidance for selecting the most suitable documentation tooling for .NET projects, helping teams decide between Starlight, Docusaurus, and DocFX based on project type, team size, and existing ecosystem.

Core Features & Use Cases

  • Decision tree that maps project context to the optimal tool.
  • Setup instructions for each platform, including Mermaid diagram support.
  • Migration paths between documentation tools.
  • Integration guidance for MarkdownSnippets and Mermaid across platforms.

Quick Start

Ask the dotnet-documentation-strategy skill to suggest the most suitable documentation framework for your .NET project.

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 documentation tooling for a .NET project?

Choosing .NET documentation tooling involves evaluating Starlight, Docusaurus, or DocFX against your project type, team size, and existing ecosystem to select the optimal framework.

How do I migrate existing documentation between DocFX and Docusaurus?

Migrating between documentation tools like DocFX and Docusaurus requires following specific migration paths to transfer content while maintaining Mermaid diagram and MarkdownSnippets integrations.

Does DocFX work well for small teams or should I use Starlight for .NET docs?

DocFX or Starlight suitability depends on a decision tree mapping your .NET project context and team size to the optimal documentation framework.

How do I set up Mermaid diagram support in Docusaurus for a .NET project?

Setting up Mermaid diagrams in Docusaurus involves following platform-specific initial setup instructions that enable diagram rendering within your .NET documentation files.

When should I not use DocFX for my .NET documentation?

You should not use DocFX when your project ecosystem or team size aligns better with Starlight or Docusaurus, as determined by evaluating your specific documentation requirements.