Audit and refactor docs around SQMeter ASCOM Alpaca bridge#43
Merged
Conversation
Reframes project documentation around the SQMeter ASCOM Alpaca bridge name. Adds dedicated docs for configuration, N.I.N.A. setup, upgrading, Windows service management, and troubleshooting. Updates the dashboard and setup page titles and removes stale tray-icon promise.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SQMeter ASCOM Alpaca/ bridge terminology. The README title is nowSQMeter ASCOM Alpacaand includes a clear "Project scope and naming" table distinguishing the bridge from the two Alpaca devices it exposes (SQMeter SafetyMonitorandSQMeter ObservingConditions).docs/nina.md.docs/configuration.md,docs/windows-service.md,docs/upgrading.md,docs/troubleshooting.md.configureddevicesexample indocs/nina-alpaca-discovery.mdto show both devices, and updates bridge-vs-device naming throughout.<title>and<h1>toSQMeter ASCOM Alpaca.PRIVACY.mdproject name.Validation
go test ./...— all packages passNotes
sqmeter-alpaca-safetymonitor; the service display name remainsSQMeter Alpaca SafetyMonitor. A note in the README project-scope section documents this.Follow-up recommendations
DeanJ87/SQMeter-Safety-Monitor→DeanJ87/SQMeter-ASCOM-Alpacaon GitHub. Requires updating badge URLs,ReleasesURLininternal/config/paths.go, installerAppURL, and any external links.sqmeter-ascom-alpacaand the Windows service display name fromSQMeter Alpaca SafetyMonitortoSQMeter ASCOM Alpaca. Requires updatinggo.modmodule path, all import paths, CI workflow build targets, GoReleaser config, Inno SetupExeName/SetupBase, and serviceName/DisplayNameinmain.go.module sqmeter-alpaca-safetymonitoringo.modshould becomesqmeter-ascom-alpacaas part of the binary rename above.AppDataDirName = "SQMeter SafetyMonitor"ininternal/config/paths.goand#define AppDataDir "SQMeter SafetyMonitor"ininstaller/setup.isscould be updated to a new name, but this is a migration-sensitive change — existing installs would lose their config path. Defer until a migration path is implemented.