Skip to content

Review and update documentation for changes since 10.0.0 #500

Description

@adrianhall

Summary

The documentation site (docs/) largely reflects the state of the library as of the 10.0.0 release. Several releases (10.0.1, 10.1.0, 10.1.1, 10.1.2) and a number of merged PRs have landed since then — some of which have already had targeted doc updates (e.g. UnsafeEntityLogging, the .NET 10 upgrade, the SQLitePCLRaw NU1903 note from #492/#498), but there has not been a full, deliberate pass to check the documentation against everything that changed since and including 10.0.0.

This issue is to track that review as its own piece of work. No review has been performed yet — this issue only records that it is needed and roughly what it should cover.

Scope of the review (once picked up)

  1. Diff the platform (src/, samples/, build/packaging) between 10.0.0 (inclusive) and the current main/latest release tag, e.g.:
    git log 10.0.0..main --oneline
    git diff 10.0.0..main -- src/ samples/
  2. For each behavior-affecting change (new features, breaking changes, changed defaults, new/removed packages, new samples/platforms, changed NuGet dependency floors, etc.), check whether docs/ (tutorials, in-depth guides, samples pages) reflects it accurately.
  3. Identify:
    • Missing documentation for new functionality.
    • Stale/incorrect documentation describing behavior that has since changed.
    • Broken or dead references (links, code samples, package versions) that drifted out of sync with the current release.
  4. Produce a follow-up plan (or a set of follow-up issues/PRs) to close the identified gaps — this issue itself should not attempt to fix anything, just scope the work.

Known candidate areas (non-exhaustive — to be confirmed by the actual review)

Out of scope for this issue

Actually performing the review and fixing the documentation — that is deliberately deferred to follow-up work once this issue is picked up.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions