dotnet/docs
Docs
This repository serves as the technical documentation source for the .NET ecosystem. It consists of a collection of conceptual guides and technical references written in Markdown, acting as the static site content source for a public documentation portal.
The project utilizes a Git-based content management system to handle technical writing through pull requests and automated build pipelines. It distinguishes itself through a specialized infrastructure that aggregates content and samples from multiple repositories and branches into a single unified output.
The system covers a broad range of documentation lifecycle capabilities, including automated publishing, metadata-driven organization, and version control for removing outdated software content. It incorporates validation tools for markdown links and metadata, as well as governance utilities for license-based dependency scanning and secret leak detection.
Administrative automation is handled through tools for issue labeling, pull request coordination, and path-based URL redirection to manage content migrations.
Features
- Technical Documentation Repositories - Provides a structured, version-controlled repository of conceptual guides and technical references for the .NET ecosystem.
- Technical Documentation - Organizes and structures large collections of technical guides, metadata, and navigation for the developer platform.
- Documentation Metadata Configurations - Provides a framework for defining product names, directory structures, and navigation options for technical guides.
- Documentation Publishing Pipelines - Converts source files and external samples into a published website through automated build and deployment pipelines.
- External Content Integrations - Links dependent Git repositories and branches to include external samples or language specifications in the build.
- Git-Based Content Management Systems - Uses a Git-based system to manage technical writing via pull requests, metadata validation, and automated checking.
- Metadata-Driven Documentation Generators - Uses structured metadata to define navigation hierarchies and relationship mappings for technical guides.
- Technical Content Sites - Processes structured markdown files through automated pipelines to generate a public technical documentation website.
- Documentation Asset Pipelines - Implements automated pipelines that process source files into final documentation assets based on predefined configuration patterns.
- Documentation Build Configurations - Defines how source files and assets are processed using inclusion patterns and destination paths for documentation.
- Static Site Documentation - Acts as the raw text and metadata source for a compiled static documentation portal.
- Content Aggregation Workspaces - Aggregates documentation and code samples from multiple Git repositories and branches into a single unified output.
- Documentation Validation - Validates required metadata and variable IDs within documentation files to ensure consistent tracking.
- Markdown Link Verifiers - Checks for broken links in markdown files while ignoring specific internal reference schemes and relative path prefixes.
- Markdown - Provides tools that verify markdown files against required metadata and structural rules before publishing.
- Documentation Versioning - Tracks and manages the lifecycle of different technical documentation versions, including the removal of end-of-support content.
- Automated Release Note Generators - Categorizes technical updates and generates summary release content by filtering file changes and labels.
- Documentation Redirects - Maintains URL redirections to prevent broken links during the reorganization of technical documentation content.
- Documentation Version Lifecycle Management - Identifies and deletes outdated software version content based on support thresholds and exclusion lists.
- Link and Metadata Validations - Checks for broken links and missing metadata within documentation files to ensure a high-quality user experience.
- Technical Release Note Generators - Filters and categorizes technical updates based on labels and file changes to generate summary release content.
- Build Configuration Management - Sets global properties and analysis settings across multiple projects to ensure consistent compilation and quality.
- License Validation Engines - Validates code sample dependencies against an approved license whitelist to ensure legal compliance.
- URL Redirections - Maintains mapping files that translate legacy source paths to current destination URLs to prevent broken links.
- Migration Redirects - Maps old source paths to new destination URLs via configuration files to prevent broken links during migrations.
- Documentation and Reference - Centralized documentation for the core platform and libraries.
