Skip to content

Conversation

@CoolatMax
Copy link

Description

This PR addresses #68 by adding comprehensive manpages for the GreenhousePython CLI.

To ensure the documentation is both maintainable and system-ready, I have provided:

  1. docs/man/greenhouse.md: A human-readable Markdown source for easy future edits.
  2. docs/man/greenhouse.1: A compiled Roff-formatted manpage for Linux man system integration.

Technical Audit & Discoveries

While drafting this manual, I performed a source code audit of main.py to identify undocumented requirements:

  • Configuration Requirement: Added documentation for the mandatory cfg.txt file and its required keys (beds, file_name_prefix).
  • Interface Structure: Documented the four primary control modules: Camera, Water (per-bed), Light, and Misc.
  • Dependency Context: Included information regarding the GTK4 and Typer foundations of the app.

How to Test

You can verify the formatting of the generated manpage by running the following in a terminal:

man ./docs/man/greenhouse.1

How does Manpages looks in the terminal:

Screenshot 1

SS1

Screenshot 2

SS2

Screenshot 3

SS3

Screenshot 4

SS4

@yeetmanthecoolman yeetmanthecoolman added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants