dotnet-github-docs

Installation
SKILL.md

dotnet-github-docs

GitHub-native documentation patterns for .NET projects: README structure with NuGet/CI/coverage badges and installation instructions, CONTRIBUTING.md with fork-PR workflow and development setup, issue templates (bug report with .NET version and repro steps, feature request with problem/solution/alternatives), PR templates with testing checklist and breaking changes section, GitHub Pages setup for documentation sites, repository metadata (CODEOWNERS, FUNDING.yml, social preview, topics/tags), and Mermaid diagram embedding in README files.

Version assumptions: .NET 8.0+ baseline for code examples. GitHub Actions for CI badges. NuGet.org for package badges.

Scope

  • README structure with NuGet/CI/coverage badges
  • CONTRIBUTING.md with fork-PR workflow
  • Issue templates (bug report, feature request)
  • PR templates with testing checklist
  • Repository metadata (CODEOWNERS, FUNDING.yml, topics/tags)
  • Mermaid diagram embedding in README files

Out of scope

  • CI/CD deployment workflows for GitHub Pages -- see [skill:dotnet-gha-deploy]
  • Changelog generation and release versioning -- see [skill:dotnet-release-management]
Related skills

More from novotnyllc/dotnet-artisan

Installs
4
GitHub Stars
208
First Seen
Feb 24, 2026