Skip to content

Update stale and inconsistent documentation #36

@cursor

Description

@cursor

Problem

Several docs are out of sync with the current codebase:

Location Issue
DBToolsUnitTest/TestDocumentation.md References old namespaces (DbTools, Utils, DBTools_Utilities)
README.md test tree Lists ProviderTests.cs; actual file is ProviderDialectTests.cs
docs/QUICKSTART.md Was missing Provider key (partially addressed in PR #24)
DBTools/Properties/AssemblyInfo.cs Still says "SQL Server wrapper"
README vs docs/SECURITY.md Config guidance partially duplicated; keep consistent after #24

Proposed solution

  1. Rewrite or remove TestDocumentation.md to match current DBTools.* namespaces and test layout
  2. Fix README test structure tree and file names
  3. Audit all docs/ files for Provider key and multi-provider examples
  4. Update assembly metadata (may overlap with Complete multi-provider naming migration (SqlClient and legacy artifacts) #32)

Acceptance criteria

  • No references to removed/renamed namespaces in active docs
  • README test tree matches actual files under DBToolsUnitTest/
  • All config examples include Provider where relevant
  • Security/config guidance is consistent across README and docs/SECURITY.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions