Skip to content

docs: update README and CHANGELOG for changes since v1.0.1#77

Merged
renedierking merged 5 commits intomasterfrom
copilot/update-readme-and-changelog
Apr 10, 2026
Merged

docs: update README and CHANGELOG for changes since v1.0.1#77
renedierking merged 5 commits intomasterfrom
copilot/update-readme-and-changelog

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 27, 2026

CHANGELOG.md had no [1.0.1] entry and no record of any post-release work. README.md was missing features added after the initial release.

Summary

Updated documentation to reflect all changes merged since v1.0.1, including PR #75 (UI Redesign), PR #78 (Device Monitoring), PR #79 (Loading Screen), PR #85 (Device Groups), PR #87 (bunit update), PR #88 (Docker ping utilities), PR #89 (MudBlazor update), and PR #90 (Scalar update).

CHANGELOG.md

  • Demoted original [Unreleased] items to ## [1.0.1]
  • New ## [Unreleased] section with ### Added / ### Changed covering:
    • Device Groups — Organize devices into named categories with automatic grouping in card view and filterable table column
    • Enhanced Loading Screen — Modern dark gradient background with animated wizard emoji and cyan progress circle
    • Device Monitoring Service — Background service with automatic device pinging, SignalR real-time updates, and online timestamp tracking
    • Device Monitoring ConfigurationDeviceMonitoringOptions using IOptions pattern
    • Docker Ping Utilities — Added iputils-ping package for ICMP ping support in containerized environments
    • Minimal API Strategy Pattern (IMinimalApiStrategy, MinimalApiStrategyExtensions)
    • Card/table view toggle + ViewPreferenceService
    • Footer bar, snackbar notifications, PcDeviceDTO.Clone()
    • Dev appsettings.development.json + #if DEBUG base address selection
    • MinimalApiStrategyTests, DeviceMonitoringServiceTests, and DtoExtensionsTests
    • Database schema changes (OnlineSince and GroupName fields)
    • All NuGet + GitHub Actions version bumps (MudBlazor 9.3.0, bunit 2.7.2, Scalar 2.13.20)
  • Proper compare links: [Unreleased]v1.0.1...HEAD, [1.0.1]v1.0.0...v1.0.1

README.md

  • Added Device Groups to Features section for organizing devices into categories
  • Added device monitoring features to Features section:
    • Real-time Device Monitoring with automatic background pinging
    • Live Status Updates via SignalR WebSocket integration
    • Online Timestamp Tracking with user-friendly display
  • Added card/table view toggle and snackbar notifications
  • Updated Minimal API section to mention TryAddEnumerable idempotency
  • Added View preference persistence subsection documenting ViewPreferenceService and its localStorage key
  • Added Device monitoring configuration subsection with example configuration and explanation of settings

How to Test

  • dotnet build LANdalf.slnx
  • dotnet test
  • (If relevant) docker compose up --build

Checklist

  • No secrets/credentials committed
  • Docs updated as needed (README/CONTRIBUTING)
  • Tests added/updated for new behavior
  • Breaking changes called out
Original prompt

Overview

Update README.md and CHANGELOG.md to accurately document all changes that have been made since tag v1.0.1. Do not touch any source code files — only documentation files.


Changes since v1.0.1 (based on the diff against v1.0.1...HEAD)

🆕 New Features / Additions

  1. Minimal API Strategy Pattern — Endpoint registration refactored into strategy classes:

    • New interface IMinimalApiStrategy (src/API/MinimalApi/IMinimalApiStrategy.cs)
    • New extensions MinimalApiStrategyExtensions (src/API/MinimalApi/MinimalApiStrategyExtensions.cs) with AddMinimalApiStrategies() (assembly scanning) and MapMinimalApiStrategies(...)
    • PcDeviceMinimalApiStrategy moves all /pc-devices/ endpoint definitions out of Program.cs
  2. Card View for Devices — The home page now supports toggling between a table view and a card view:

    • New DeviceCard.razor component (src/UI/Components/DeviceCard.razor)
    • New DeviceEditDialog.razor component (src/UI/Components/DeviceEditDialog.razor)
    • New ViewPreferenceService (src/UI/Services/ViewPreferenceService.cs) — persists view preference to localStorage
    • Toggle button added to home page toolbar
  3. Footer Bar — A persistent bottom MudAppBar now shows the app version and a GitHub link.

  4. Snackbar Notifications — Add, update, delete, and WoL actions now show ISnackbar toasts instead of silent failures.

  5. PcDeviceDTO.Clone() Extension — New Extensions.cs in src/UI/ApiClient/ adds a Clone() helper to avoid editing live objects in dialogs.

  6. Development appsettings — Added src/UI/wwwroot/appsettings.development.json with ApiBaseAddress set to https://localhost:7206/ for local dev. The Program.cs now uses #if DEBUG to select the right base address.

🔧 Changed

  • Home.razor fully refactored: inline data-grid edit replaced by a dedicated DeviceEditDialog modal; CommittedItemChanges removed; separate AddNewDevice/UpdateDevice methods introduced; LoadData split into initial load + RefreshData.
  • MainLayout.razor: theme toggle button uses aria-label instead of Title; footer AppBar added.
  • ThemeService.cs: dark-mode primary color changed from #bb86fc to #4fc3f7.
  • Program.cs (API): all endpoint definitions moved to PcDeviceMinimalApiStrategy; indentation fixed; dead comment removed.
  • Program.cs (UI): registers ViewPreferenceService; #if DEBUG conditional for ApiBaseAddress.
  • MudBlazor upgraded from 8.* to 9.2.0.

⬆️ Dependency / Tooling Upgrades

  • dotnet-ef: 10.0.110.0.5
  • Microsoft.AspNetCore.OpenApi: 10.0.310.0.5
  • Microsoft.EntityFrameworkCore.Sqlite: 10.0.310.0.5
  • Microsoft.EntityFrameworkCore.Tools: 10.0.310.0.5
  • Scalar.AspNetCore: 2.12.502.13.15
  • FluentAssertions: 8.8.08.9.0
  • Microsoft.EntityFrameworkCore.InMemory: 10.0.310.0.5
  • Microsoft.AspNetCore.Mvc.Testing: 10.0.310.0.5
  • GitHub Actions: docker/setup-qemu-action v3→v4, docker/setup-buildx-action v3→v4, docker/login-action v3→v4, docker/metadata-action v5→v6, docker/build-push-action v6→v7

🧪 Tests Added

  • MinimalApiStrategyTests — covers AddMinimalApiStrategies registration, deduplication, and MapMinimalApiStrategies delegation.
  • HomeComponentTests updated to inject ViewPreferenceService.

Tasks

1. Update CHANGELOG.md

The current CHANGELOG.md only has an [Unreleased] section with the initial v1.0 items. It does not have a [1.0.1] entry or anything beyond that.

Update it to:

  • Add a ## [1.0.1] section that captures what was presumably in the initial release (the existing [Unreleased] items).
  • Add a new ## [Unreleased] section (or ## [1.0.2] - Unreleased) that lists all the changes above, organised under ### Added, ### Changed, ### Fixed (if relevant), using the Keep a Changelog format.
  • Update the diff links at the bottom (e.g. [1.0.1]: https://github.com/renedierking/LANdalf/compare/v1.0.0...v1.0.1 and [Unreleased]: https://github.com/renedierking/LANdalf/compare/v1.0.1...HEAD).

2. Update README.md

The README already has a partial update (Minimal API pattern section was added in the diff). Review and enrich the following sections to reflect the new state:

  • Features section: Add "Card/Table view toggle with persistent preference" and "Snackbar notifications for user actions" as bullet points.
  • Development section: Ensure the Minimal API extension pattern description is accurate and complete (it already exists in HEAD). Add a note about the ViewPreferenceService and its localStorage-based persistence.
  • Interface Preview: The existing placeholder image reference is fine; no changes needed there.
  • Any version badges or references to package versions that may be stale can be updated if appropriate (e.g. MudBlazor version).

Keep all existing content intact — only add or update relevant se...

This pull request was created from Copilot chat.


💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

Copilot AI changed the title [WIP] Update README.md and CHANGELOG.md for changes since v1.0.1 docs: update README and CHANGELOG for changes since v1.0.1 Mar 27, 2026
Copilot AI requested a review from renedierking March 27, 2026 21:20
@renedierking
Copy link
Copy Markdown
Owner

@claude[agent] re-update the readme + docs since the last pull request

@Claude
Copy link
Copy Markdown
Contributor

Claude AI commented Mar 28, 2026

@claude[agent] re-update the readme + docs since the last pull request

Updated README.md and CHANGELOG.md to include the device monitoring feature from PR #78, which adds:

  • Background service with automatic device pinging (configurable intervals)
  • Real-time status updates via SignalR WebSockets
  • Online timestamp tracking with user-friendly display
  • Full documentation of DeviceMonitoringOptions configuration

Changes committed in b3404f5.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • 10.0.0.255
    • Triggering command: REDACTED, pid is -1 (packet block)
  • 10.1.15.255
    • Triggering command: REDACTED, pid is -1 (packet block)
  • 172.16.0.255
    • Triggering command: REDACTED, pid is -1 (packet block)
  • 192.168.1.255
    • Triggering command: REDACTED, pid is -1 (packet block)
  • 255.255.255.255
    • Triggering command: REDACTED, pid is -1 (packet block)

If you need me to access, download, or install something from one of these locations, you can either:

@renedierking
Copy link
Copy Markdown
Owner

@claude[agent] re-update the readme + docs since the last pull request

@Claude
Copy link
Copy Markdown
Contributor

Claude AI commented Apr 10, 2026

@claude[agent] re-update the readme + docs since the last pull request

Updated README.md and CHANGELOG.md to document all changes merged since the last update, including:

Changes committed in 600aea1.

@renedierking renedierking marked this pull request as ready for review April 10, 2026 20:36
@renedierking renedierking merged commit 7de452b into master Apr 10, 2026
3 checks passed
@renedierking renedierking deleted the copilot/update-readme-and-changelog branch April 10, 2026 20:38
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.

3 participants