V10.5.4/service update#166
Merged
Merged
Conversation
Update Docker base image nginx from 1.31.0 to 1.31.1. Upgrade NuGet packages including Codebelt extensions (11.0.9 → 11.1.0, 1.2.6 → 1.3.0), Microsoft.NET.Test.Sdk (18.5.1 → 18.6.0), and runtime packages (net9 and net10 patch updates).
Enhance the published API documentation with comprehensive namespace guidance, consumer-oriented descriptions, extension member tables, and concrete type-level examples. Improves discoverability and usability of the library's public API across 100+ modified and 570+ new documentation files.
Expand type-level documentation across 220 public API classes, structs, interfaces, and extension methods with enhanced examples and improved descriptions. Update docfx.json to include type documentation in the published API reference build pipeline, enabling comprehensive type-level guidance alongside existing namespace documentation.
Add comprehensive DocFX documentation maintenance standards to AGENTS.md. Establishes requirements for public type documentation (examples, overwrite files, availability metadata), namespace-level extension member tables, and verification workflows. Clarifies the distinction between type page examples and namespace overview documentation, ensuring consistent, high-quality API reference generation.
|
Too many files changed for review. ( |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #166 +/- ##
=======================================
Coverage 94.19% 94.19%
=======================================
Files 602 602
Lines 19186 19186
Branches 2009 2009
=======================================
Hits 18073 18073
Misses 1049 1049
Partials 64 64 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Add release entry for 10.5.4 (2026-06-20) documenting dependency upgrades, test infrastructure improvements, and comprehensive API documentation enhancements. Update compare-link footer with v10.5.4 tag reference.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates and improves the documentation for multiple ASP.NET Core-related namespaces, making the summaries more actionable, user-focused, and easier to understand. It also introduces new extension member documentation and adds a new namespace for middleware infrastructure. Additionally, the NGINX base image version is updated in the Dockerfile.
Documentation improvements and new content:
General documentation enhancements:
Cuemon.AspNetCore.Authentication,Cuemon.AspNetCore.Builder,Cuemon.AspNetCore.Configuration,Cuemon.AspNetCore.Diagnostics,Cuemon.AspNetCore.Hosting,Cuemon.AspNetCore.Http,Cuemon.AspNetCore.Http.Headers,Cuemon.AspNetCore.Http.Throttling, and all related MVC filter and formatter namespaces. The new summaries are more prescriptive, highlighting when and how to use each namespace and their key entry points. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]New and expanded extension member documentation:
Cuemon.AspNetCore.Http,Cuemon.AspNetCore.Http.Headers, andCuemon.AspNetCore.Diagnostics, making it easier for developers to discover available extension points. [1] [2] [3]New namespace documentation:
Cuemon.AspNetCore.Infrastructurenamespace, describing its role in simplifying middleware creation.Other changes:
Dockerfile update:
.docfx/Dockerfile.docfxfrom1.31.0-alpineto1.31.1-alpinefor improved security and stability.