Skip to content

docs: remove stale AutoMapper references (#241) - #381

Merged
hokiepokedad2 merged 2 commits into
mainfrom
docs/241-remove-automapper-refs
Aug 5, 2026
Merged

docs: remove stale AutoMapper references (#241)#381
hokiepokedad2 merged 2 commits into
mainfrom
docs/241-remove-automapper-refs

Conversation

@hokiepokedad2

Copy link
Copy Markdown
Contributor

Closes #241.

AutoMapper was removed in v2.6.0 (#173) in favour of manual mapping extensions, but the docs site never caught up. Four pages still described it as the live mapping layer — architecture/backend.md even carried a working-looking .ForAllMembers(opts => opts.Condition(...)) snippet for code that exists nowhere in the repo (grep -rn AutoMapper --include=*.cs --include=*.csproj returns nothing).

The issue points at architecture/overview.md:94-95; there were five stale spots across four files.

Changes

File What changed
docs/architecture/overview.md Core.Mappings/ line in the solution tree; "AutoMapper for partial updates" section rewritten as "Manual mapping extensions" with a link to Backend Patterns
docs/architecture/backend.md "AutoMapper (non-alarm entities only)" section replaced with "Mapping extensions" — covers AlarmMappingExtensions (To*() / ApplyUpdate()) and EntityMappingExtensions (ToModel() / ToEntity() / ApplyTo()), and swaps the fake .ForAllMembers snippet for the real ApplyUpdate null-skip guards
docs/development/testing.md Test-coverage bullet now names MappingExtensionTests and what it actually covers
docs/architecture/poracleng-proxy.md Dropped "or AutoMapper" from the alarm-type note
Tests/.../Mappings/PoracleMappingProfileTests.cs Renamed to MappingExtensionTests.cs

The test file rename is the last bit of AutoMapper residue outside the docs: the file kept its "mapping profile" name while the class inside it had already been renamed to MappingExtensionTests. Pure git mv — no content change, and nothing (csproj, workflow, doc) referenced the old path.

Both surviving mentions of "AutoMapper" in docs/ are the new sentences that state there isn't a dependency, kept so the next reader doesn't reintroduce it.

Verification

  • dotnet test --filter MappingExtensionTests — 66 passed, 0 failed
  • No #automapper… anchor links anywhere in docs/, mkdocs.yml, or README.md, so no cross-references break with the heading renames
  • Frontend lint/prettier are scoped to ClientApp/src/** and are untouched by this change

AutoMapper was dropped in v2.6.0 (#173) in favour of manual mapping
extensions, but four docs pages still described it as the live mapping
layer -- architecture/backend.md even carried a .ForAllMembers snippet
that exists nowhere in the codebase.

The mapping sections in architecture/overview.md and
architecture/backend.md now describe AlarmMappingExtensions (To*() /
ApplyUpdate()) and EntityMappingExtensions (ToModel() / ToEntity() /
ApplyTo()), with a real ApplyUpdate snippet showing the explicit
null-skip guards. The Core.Mappings/ line in the solution tree, the
test-coverage bullet in development/testing.md, and a passing mention
in architecture/poracleng-proxy.md are corrected to match.

Also renames the mapping test file, which was still called
PoracleMappingProfileTests.cs while the class inside it had already
been renamed to MappingExtensionTests. Nothing referenced the old file
name; all 66 tests pass unchanged.
@github-actions github-actions Bot added the docs label Aug 5, 2026
@hokiepokedad2
hokiepokedad2 merged commit d4363d3 into main Aug 5, 2026
8 checks passed
@hokiepokedad2
hokiepokedad2 deleted the docs/241-remove-automapper-refs branch August 5, 2026 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove stale AutoMapper references in architecture overview

1 participant