Where to Find dotnet/skills Documentation: Complete Guide to Project Resources
All official dotnet/skills documentation lives inside the repository itself, starting with the root README.md and extending through specialized guides in eng/skill-validator/src/, plugin-specific READMEs under plugins/, and architectural design docs in the docs/ folder.
The dotnet/skills repository hosts a comprehensive ecosystem of AI-powered development tools contained entirely within its source tree. Unlike traditional projects with external documentation sites, this project maintains all guides, references, and design notes alongside the code. Understanding the documentation structure helps you quickly navigate from high-level overviews to specific implementation details for skills, validators, and plugins.
Core Documentation Locations
Root README and Quick Start
The primary entry point for dotnet/skills documentation is README.md at the repository root. This file contains the project overview, installation instructions for the skill-installer, and a "What’s Included" table listing every plugin and skill. It also documents marketplace registration commands and basic CLI usage patterns.
Skill-Validator Reference
For testing and validation workflows, refer to eng/skill-validator/src/README.md. This document details the skill-validator CLI syntax, including flags like --runs, --model, and --verbose. It explains the eval file format and provides instructions for downloading nightly builds or running the validator without global installation using dnx.
Eval Results Investigation
When analyzing validation failures, consult eng/skill-validator/src/docs/InvestigatingResults.md. This guide covers the JSON schema for eval results and provides step-by-step instructions for downloading artifacts and inspecting failure details.
Plugin-Specific Documentation
Each plugin maintains its own README under plugins/<plugin-name>/README.md. Key examples include:
plugins/dotnet/README.md— Core .NET plugin documentationplugins/dotnet-test/README.md— Testing-specific skills and configurationplugins/dotnet-upgrade/README.md— Upgrade tooling documentation
Contributing and Design Documentation
Contribution Guidelines
The CONTRIBUTING.md file outlines rules for adding new skills, plugin layout requirements, PR triage workflows, and code ownership policies. This is the authoritative source for anyone extending the project with new capabilities.
Architectural Design Docs
The docs/ directory contains architectural diagrams, PR-triage workflows, and experimental feature notes. Specific files such as docs/dotnet-experimental/exp-test-maintainability-design-notes.md provide deep context for experimental features.
Security and Workflow References
Security policies and vulnerability scanning setup reside in SECURITY.md. For CI/CD pipeline details, examine .github/workflows/skill-validator.yml, which documents the automated validation processes that run against the codebase.
Practical Navigation Examples
When working with the documentation, use these verified commands from the source:
# Register the marketplace (documented in root README)
skill-installer marketplace add dotnet/skills
# Install a specific skill (e.g., code-testing-researcher)
skill-installer install https://github.com/dotnet/skills/tree/main/plugins/dotnet-test/skills/code-testing-researcher
# Run validation with documented flags
skill-validator run --eval eval.yaml --runs 3 --model gpt-4o
# Download results for investigation
gh run download <run-id> --repo dotnet/skills --pattern "skill-validator-results-*" --dir ./eval-results
Summary
- The root
README.mdserves as the primary entry point for dotnet/skills documentation, covering installation and marketplace setup. - Validation documentation resides in
eng/skill-validator/src/README.mdwith deep-dive investigation guides ineng/skill-validator/src/docs/InvestigatingResults.md. - Each plugin maintains documentation at
plugins/<plugin>/README.mdwith specific skill configurations and inputs/outputs. - Contribution standards and architectural decisions are documented in
CONTRIBUTING.mdand thedocs/directory respectively.
Frequently Asked Questions
Where is the main dotnet/skills documentation entry point?
The main documentation starts at the root README.md in the repository, which provides the project overview, installation instructions, and links to all plugin-specific documentation.
How do I find documentation for the skill validator tool?
The skill-validator documentation is located at eng/skill-validator/src/README.md, which includes complete CLI syntax, eval file formats, and flags such as --runs and --model.
Can I find documentation for individual plugins in the repository?
Yes, each plugin contains its own README file under plugins/<plugin-name>/README.md, detailing available skills, input/output specifications, and configuration options.
Where are the contribution guidelines for dotnet/skills?
Contribution guidelines, including rules for adding new skills and plugin layout standards, are documented in CONTRIBUTING.md at the repository root.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" Maintain an open-source project? Get it listed too →