docs: reconcile documentation with changes since 10.0.0#503
Merged
Conversation
- Update README.md prerequisite versions (ASP.NET Core / .NET 10.x) and add Blazor WASM to the tested client platform list, matching docs/index.md. - Fix stale '.NET 8+' wording in the client tutorial to match the current minimum supported version. - Document the UnsafeEntityLogging table controller option in the server tutorial (part-1) and the sample server walkthrough, which previously only demonstrated it in sample source code comments (CommunityToolkit#446/CommunityToolkit#470, CommunityToolkit#476-CommunityToolkit#480). Also fixes a pre-existing duplicate base() call in the tutorial's expanded controller sample. - Rename docs/in-depth/server/openapi/net9.md to net10.md and update the mkdocs nav label and internal link, since the page content and the underlying feature have referred to .NET 10 for a while. - Add a new samples walkthrough page for the Blazor WASM sample (previously undocumented) and wire the long-orphaned in-depth/client/advanced/blazor-wasm.md page into the mkdocs nav. Cross-link both from the client tutorial's existing Blazor admonition. Closes CommunityToolkit#500
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.
Summary
Closes #500 — the documentation review/scoping issue tracking drift between
docs/,README.md, and everything that changed since the 10.0.0 release.This PR performs the review described in #500 and fixes every gap found directly, rather than filing separate follow-up issues:
docs/index.mdandsrc/Directory.Build.props'snet10.0target). Also added Blazor WASM to the tested client platform list, whichdocs/index.mdalready listed but README omitted.docs/tutorial/client/part-1.mdcontradicteddocs/index.mdon the minimum .NET version (".NET 8+" vs ".NET 10.x or later").UnsafeEntityLogging(SECURITY: Add TableOptions flag for unsafe entity logging #446/feat: add UnsafeEntityLogging option to guard entity serialization in logs (#446) #470) was undocumented in the tutorials/samples — prior doc PRs (Examples: Demonstrate UnsafeEntityLogging in the todoapp-tutorial server walkthrough (#446) #476-Examples: Review todoapp-mvc server for UnsafeEntityLogging secure default (#446) #480, docs: demonstrate UnsafeEntityLogging in todoapp-tutorial server walkthrough (#476) #487-fix: resolve remaining sample package drift and Microsoft.OpenApi NU1903 #493) only addedUnsafeEntityLogging = falseto sample source code comments, never to the actual walkthrough prose indocs/tutorial/server/part-1.mdordocs/samples/todoapp/server.md. Both now explain the option, consistent withdocs/in-depth/server/index.md. (Also fixed an unrelated pre-existing duplicatebase()call in thepart-1.mdcode sample I was already editing.)docs/in-depth/server/openapi/net9.mdwas titled "# .NET 10.x OpenApi support" in its own content, but the filename and mkdocs nav label still said "net9"/".NET 9.x". Renamed tonet10.mdand updated the nav label and the internal link indocs/in-depth/server/index.md.docs/in-depth/client/advanced/blazor-wasm.mdpage (added in (#330) Blazor WASM sample and docs updates. #394, mid-2025) was never wired into the mkdocs nav, making it unreachable via normal site navigation. Added a newdocs/samples/todoapp/blazor-wasm.mdwalkthrough (framed as an online-only client, consistent with the existing "Blazor usage" admonition in the client tutorial) and added both pages tomkdocs.shared.yml's nav. Cross-linked from the tutorial's Blazor admonition.Out of scope (reviewed, no action needed)
main.Verification
mkdocs buildandmkdocs build --strictrun locally against the changed nav/pages — no broken links, no orphaned-page warnings (the pre-existing mermaid-plugin network-check warning in strict mode is unrelated/pre-existing and not from a docs link).