Skip to content

docs: reconcile documentation with changes since 10.0.0#503

Merged
adrianhall merged 1 commit into
CommunityToolkit:mainfrom
adrianhall:issues/500
Jul 6, 2026
Merged

docs: reconcile documentation with changes since 10.0.0#503
adrianhall merged 1 commit into
CommunityToolkit:mainfrom
adrianhall:issues/500

Conversation

@adrianhall

Copy link
Copy Markdown
Collaborator

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:

  1. README.md prerequisites were stale — said "ASP.NET 8 or later" / ".NET 8 or later" instead of the current 10.x minimum (matches docs/index.md and src/Directory.Build.props's net10.0 target). Also added Blazor WASM to the tested client platform list, which docs/index.md already listed but README omitted.
  2. docs/tutorial/client/part-1.md contradicted docs/index.md on the minimum .NET version (".NET 8+" vs ".NET 10.x or later").
  3. 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 added UnsafeEntityLogging = false to sample source code comments, never to the actual walkthrough prose in docs/tutorial/server/part-1.md or docs/samples/todoapp/server.md. Both now explain the option, consistent with docs/in-depth/server/index.md. (Also fixed an unrelated pre-existing duplicate base() call in the part-1.md code sample I was already editing.)
  4. Stale OpenApi doc page namingdocs/in-depth/server/openapi/net9.md was titled "# .NET 10.x OpenApi support" in its own content, but the filename and mkdocs nav label still said "net9"/".NET 9.x". Renamed to net10.md and updated the nav label and the internal link in docs/in-depth/server/index.md.
  5. Blazor WASM sample was undocumented on the site, and a pre-existing docs/in-depth/client/advanced/blazor-wasm.md page (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 new docs/samples/todoapp/blazor-wasm.md walkthrough (framed as an online-only client, consistent with the existing "Blazor usage" admonition in the client tutorial) and added both pages to mkdocs.shared.yml's nav. Cross-linked from the tutorial's Blazor admonition.

Out of scope (reviewed, no action needed)

Verification

  • mkdocs build and mkdocs build --strict run 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).
  • Manual diff review to confirm only the intended files changed.

- 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
@adrianhall adrianhall merged commit 526c846 into CommunityToolkit:main Jul 6, 2026
1 check passed
@adrianhall adrianhall deleted the issues/500 branch July 6, 2026 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review and update documentation for changes since 10.0.0

1 participant