docs(structural): meta-docs sync per holistic critique#32
Merged
Conversation
- README/SCOPE: update baseline to .NET 10 / C# 14 / Aspire 9.x (net8/9) + Aspire 13 (net10), refresh advertised decision-tree list, route reading paths through decision-trees.md first. - glossary: add RequiredScope, DistributedApplicationTestingBuilder, Workload Identity, Federated Identity Credentials, slnx, Traversal SDK, dotnet-affected with primary-source citations. - coverage-map: name owners for ch02 sections (HttpClient, OutputCache, BackgroundWork, Security, gRPC, SignalR, HealthChecks endpoint mapping) and ch06 sections (Configuration, Resilience, HealthChecks probe contract, GracefulShutdown, CI/CD, Networking, Multi-tenancy, Cost). Weaken the per-line checklist deep-link claim to match reality (footer chapter list). - decision-trees: rewrite tree 12 (auth) to mirror ch02 §10 — separate delegated and app-only policies, no single OR-claims policy. Point tree 15 (resilience) at single owner ch02 §7. Convert all References lines to section anchors. Add tree 16 (Aspire scope: AppHost vs service) and tree 17 (Cosmos partition key) so the README list is honest. - patterns/anti-patterns: make 'God csproj' fix architecture-neutral — vertical slice, clean/onion, modular monolith all valid; rule is split at bounded-context seams with host as the only infra-referencing project. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Applies the META-DOCS findings from the holistic critique (
holistic.critique.json).Per-file changes
README.mddocs/decision-trees.mdset (now 17 trees, including Aspire scope and Cosmos partition key — added in this PR).SCOPE.mddocs/decision-trees.md, matching README's positioning of decision-trees as the synthesis entrypoint.glossary.mdAdded (alphabetically, with
Source:lines pointing at primary sources):DistributedApplicationTestingBuilder(Aspire testing host)dotnet-affected(monorepo CI fan-out)Federated Identity Credentials(Entra → external OIDC issuers)RequiredScope(Microsoft.Identity.Web attribute, ch02 §10)slnx (.NET 9 solution format)(the XML solution format)Traversal SDK (Microsoft.Build.Traversal)Workload Identity(AKS keyless workload-auth)coverage-map.mdchecklist.mdactually does.docs/decision-trees.mdscp; app-only requiresroles+azpallow-list + absence ofscp), composed at the endpoint viaRequireAuthorization('Delegated','App'). The previous 'combined OR-claims policy' branch (which ch02 explicitly rejects as a privilege-escalation bug) is gone.docs/02-aspnetcore.md#7-resilience); ch06 references that section, doesn't co-own it. Hedging branch now usesAddStandardHedgingHandler.References:lines converted from file-level links to section-anchor links.Aspire.Hosting.*belongs in the AppHost project only;Aspire.<Vendor>.<Tech>client integrations belong in the service project. Routes to ch06 §1.patterns/anti-patterns.mdStyle
-bullets, primary-source URLs on every new normative claim, one sentence per line in new prose, no heading skips.Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com