Skip to content

docs: align NUT config docs with runtime behavior - #50

Open
patrix87 wants to merge 2 commits into
hardwarehaven:mainfrom
patrix87:documentation-fix
Open

docs: align NUT config docs with runtime behavior#50
patrix87 wants to merge 2 commits into
hardwarehaven:mainfrom
patrix87:documentation-fix

Conversation

@patrix87

@patrix87 patrix87 commented Mar 30, 2026

Copy link
Copy Markdown

This PR aligns documentation with current implementation.

  • Remove obsolete nut.hostname entry
  • Document nut.ups as ups@hostname
  • Update quickstart config example accordingly
  • Remove unused configurations

The error was introduced in this commit where hostname was removed but documentation was added mentionning it.

Copilot AI review requested due to automatic review settings March 30, 2026 02:15

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates NUT configuration documentation to match the current runtime configuration model (single nut.ups string rather than separate ups + hostname fields).

Changes:

  • Remove the obsolete nut.hostname entry from docs.
  • Document nut.ups as <ups-name>@<hostname> and update the quickstart YAML example accordingly.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/quickstart.md Updates the minimal config example to use ups@hostname and removes nut.hostname.
docs/configuration.md Updates the nut.ups format documentation and removes the hostname option from the config reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/configuration.md Outdated
Comment thread docs/quickstart.md Outdated
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.

2 participants