Skip to content

Improve Utilities documentation and consistency #47

Description

@coelacant1

Description

The Utilities/ directory scripts lack consistent documentation and follow varying conventions. As the utility library grows and more scripts depend on shared functions (ArgumentParser.sh, Communication.sh, etc.), documentation and consistency become critical for contributors and maintainers.

This covers reviewing all utility scripts for consistent style, adding usage documentation, and ensuring function signatures and behaviors are predictable.

Acceptance Criteria

  • All scripts in Utilities/ have header comments describing purpose and usage
  • Function signatures are consistent (naming conventions, parameter ordering)
  • Shared functions are documented with expected inputs and outputs
  • README or documentation in Utilities/ directory explains available utilities

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreRefactor, dependency update, CI, docsinfraProxmox, Ceph, SDN, networking, host scripts

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions