dotnet-documentation-strategy

The best .NET documentation tool depends on your project context, team size, and ecosystem. Starlight, Docusaurus, and DocFX are the primary recommended options, chosen via a decision tree that evaluates project needs and team expertise.

To add Mermaid diagram support to Docusaurus or DocFX, you must configure specific platform integration settings. The documentation strategy provides detailed setup and configuration instructions for enabling Mermaid rendering across these different tools.

To keep code snippets in .NET documentation up to date, integrate MarkdownSnippets into your documentation workflow. This verifies that code examples remain accurate and synchronized with your actual source code files.

Yes, you can migrate an existing DocFX documentation site to Starlight. The strategy provides specific guidance on migration paths for moving documentation projects between different supported tools.

DocFX and Docusaurus suitability for small .NET teams depends on specific project needs and team expertise. The strategy offers a tooling decision tree to compare platforms based on your team's scale and ecosystem requirements.