docs: add manpage in markdown and roff format #99
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.
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:
docs/man/greenhouse.md: A human-readable Markdown source for easy future edits.docs/man/greenhouse.1: A compiled Roff-formatted manpage for Linuxmansystem integration.Technical Audit & Discoveries
While drafting this manual, I performed a source code audit of
main.pyto identify undocumented requirements:cfg.txtfile and its required keys (beds,file_name_prefix).How to Test
You can verify the formatting of the generated manpage by running the following in a terminal:
How does Manpages looks in the terminal:
Screenshot 1
Screenshot 2
Screenshot 3
Screenshot 4