dotnet-github-docs

Generate GitHub-native documentation scaffolds for .NET repositories.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardizes and accelerates the creation of consistent GitHub documentation for .NET projects, including README patterns, CONTRIBUTING, issue templates, PR templates, and repository metadata.

Core Features & Use Cases

  • README structure with badges, CI/CD status, and installation guidance.
  • CONTRIBUTING.md with fork-PR workflow and development setup.
  • Issue templates (bug report, feature request) and PR templates (testing checklist, breaking changes).
  • GitHub Pages preparation and repository metadata (CODEOWNERS, FUNDING.yml, social previews, topics).
  • Mermaid diagram embedding and cross-skill references for documentation strategy.

Quick Start

Create the initial docs scaffold by adding a SKILL.md with frontmatter and the recommended folders to bootstrap GitHub-native docs for a .NET project.

Frequently Asked Questions about dotnet-github-docs

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

FAQPage Schema
How do I create standard GitHub issue and PR templates for a .NET repository?

To create GitHub issue and PR templates for a .NET repository, you can scaffold bug report, feature request, and testing checklist files. This standardizes contributions by automating consistent documentation patterns directly in your repository.

What should a README for a .NET project include for consistent documentation?

A consistent .NET README should include CI/CD status badges, installation guidance, and structured repository metadata. Automating this scaffolding ensures projects maintain standardized documentation patterns across multiple repositories.

How do I set up CONTRIBUTING.md with a fork-PR workflow for .NET projects?

Setting up CONTRIBUTING.md with a fork-PR workflow involves generating a standardized file that outlines development setup and contribution guidelines. This provides clear instructions for developers looking to contribute to the .NET project.

Can I generate repository metadata like CODEOWNERS and FUNDING.yml for .NET projects?

Yes, you can generate repository metadata like CODEOWNERS and FUNDING.yml alongside GitHub Pages preparation and social previews. This ensures your .NET repository has complete and standardized governance files.

Do I need a SKILL.md file to bootstrap GitHub-native docs for .NET?

Yes, bootstrapping GitHub-native docs requires adding a SKILL.md file with frontmatter containing the name and description. You also need to create recommended scripts, references, and assets directories to satisfy repository-structure requirements.

How do I embed Mermaid diagrams in .NET project documentation?

To embed Mermaid diagrams in .NET project documentation, you can use cross-skill references and documentation strategies. This enables visual diagram embedding directly within your standardized README and markdown files.