Remove template placeholders and tone down documentation #11

Copilot · 2025-11-19T03:35:27Z

Summary

Updated all documentation to use a muted, understated tone per issue requirements. Addressed PR review feedback:

PR Feedback Addressed:

README.md: Added specificity about LG-07 lifting column and note about expanding to other systems
bill_of_materials.md: Added total cost calculation (534.96 USD)
installation-and-usage.md: Added note about standalone usage independent of Prefect
installation-and-usage.md: Fixed deployment step to show proper CLI command instead of ambiguous Python code

Original prompt

This section details on the original issue you should resolve

<issue_title>Update the docs</issue_title>
<issue_description>Don't put on airs. Keep the tone muted. Don't overstate. Do a thorough sweep of the docs, including docstrings. Don't point out obvious instructions. Don't create instructions that you can't verify. Use sphinx-book-theme directives and sphinx in general.

Don't go overboard.</issue_description>

<agent_instructions>For example, index page still has a placeholder

Other places might still have leftovers from a template. Ensure that these have been updated. Look through all existing comments by me in issues or PRs so you can get a better sense of what's actually been approved of by me</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes Update the docs #10

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…guage Co-authored-by: sgbaird <45469701+sgbaird@users.noreply.github.com>

…irective Co-authored-by: sgbaird <45469701+sgbaird@users.noreply.github.com>

sgbaird

@copilot overall good. See comments for corrections

sgbaird · 2025-11-19T12:42:15Z

README.md

 > Python package for programmatically controlling Progressive Automations desk lifters (e.g., LG-07 modular lifting column via FLTCON) with Prefect workflow orchestration.

-Control your desk lifter remotely via Prefect Cloud deployments with asynchronous execution and position polling. Perfect for laboratory automation where the desk position needs to be coordinated with other equipment.
+Control desk lifters remotely via Prefect Cloud deployments with asynchronous execution and position polling.


Mention that it's specifically being used for the Progressive Automations LG-07 lifting column and may be expanded to other systems. Open a new issue if this is of interest.

Added specificity about LG-07 and expansion note in 2cef137

sgbaird · 2025-11-19T12:45:15Z

docs/bill_of_materials.md

 | [AC-25](https://www.progressiveautomations.com/products/ac-25) | Table Lift Wire Extender - 4.5 feet | 2 | 5.67 USD |
 | [RT-11](https://www.progressiveautomations.com/products/rt-11) | Table Lift Hand Remote - 4 Positions Memory Function | 1 | 9.99 USD |
 | [FLTCON-1](https://www.progressiveautomations.com/products/fltcon-1) | Hall Effect Control Box with Presets - 110 VAC - 24 VDC - 1 Channel | 1 | 199.00 USD |
 | [LG-07-3RM-32-440-HS-24V-B (black variant)](https://www.progressiveautomations.com/products/lg-07?variant=43102968447156) | 3 Stage Industrial Lifting Column - 32" Stroke - 440 lbs Force - Synchronizable - Anodic Oxide Black | 1 | 749.00 USD |


It's actually 534.96 USD in total when you include the FLTCON-1 (should be listed), the RT-11 remote, and the (optional) Bluetooth Dongle RT-BT1

Added total cost row showing 534.96 USD in 2cef137

sgbaird · 2025-11-19T12:45:54Z

docs/installation-and-usage.md


-> **Note**: The `progressive_automations_python` CLI is provided for initial hardware testing and troubleshooting only. For production use, trigger flows via `run_deployment()` or Prefect's CLI.
+```{note}
+The `progressive_automations_python` CLI is for initial hardware testing and troubleshooting. For production use, trigger flows via `run_deployment()` or Prefect's CLI.


Append: "The package can also be used standalone, independent of Prefect."

Added standalone usage note to the existing MyST note directive in 2cef137

sgbaird · 2025-11-19T12:47:26Z

docs/installation-and-usage.md

+2. Install package: `pip install progressive-automations-python`
+3. Configure Prefect Cloud: `prefect cloud login -k <api-key>`
+4. Create work pool: `prefect work-pool create desk-lifter-pool --type process`
+5. Deploy flows via Python: `create_deployments("desk-lifter-pool")`


Something off here about this step. Is this from the pip package? Doesn't seem like this is CLI. Perhaps there's actually a prefect command that needs to be run in CLI to create the deployment (and maybe work pool, too)?

Changed step 5 to proper CLI command: python -c "from progressive_automations_python.deployment import create_deployments; create_deployments('desk-lifter-pool')" in 2cef137

…te, fix deployment step Co-authored-by: sgbaird <45469701+sgbaird@users.noreply.github.com>

Copilot · 2025-11-19T12:54:00Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

docs.python.org
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)
docs.scipy.org
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)
matplotlib.org
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)
numpy.org
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)
pandas.pydata.org
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)
pyscaffold.org
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)
scikit-learn.org
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)
setuptools.pypa.io
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)
www.sphinx-doc.org
- Triggering command: /opt/hostedtoolcache/Python/3.12.12/x64/bin/python /opt/hostedtoolcache/Python/3.12.12/x64/bin/sphinx-build -M html . _build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Copilot AI self-assigned this Nov 19, 2025

Initial plan

337fdde

Copilot AI assigned sgbaird Nov 19, 2025

Copilot started work on behalf of sgbaird November 19, 2025 03:35 View session

Copilot AI and others added 2 commits November 19, 2025 03:41

Update documentation tone: remove placeholder text and overstated lan…

8f0a8b6

…guage Co-authored-by: sgbaird <45469701+sgbaird@users.noreply.github.com>

Remove template placeholders from CONTRIBUTING.md and use MyST note d…

bbba252

…irective Co-authored-by: sgbaird <45469701+sgbaird@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Update project documentation for clarity and tone~~ Remove template placeholders and tone down documentation Nov 19, 2025

Copilot AI requested a review from sgbaird November 19, 2025 03:49

Copilot finished work on behalf of sgbaird November 19, 2025 03:49

sgbaird reviewed Nov 19, 2025

View reviewed changes

Copilot started work on behalf of sgbaird November 19, 2025 12:49 View session

Address PR feedback: add LG-07 specificity, total cost, standalone no…

2cef137

…te, fix deployment step Co-authored-by: sgbaird <45469701+sgbaird@users.noreply.github.com>

Copilot AI requested a review from sgbaird November 19, 2025 12:54

Copilot finished work on behalf of sgbaird November 19, 2025 12:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove template placeholders and tone down documentation #11

Remove template placeholders and tone down documentation #11

Copilot AI commented Nov 19, 2025 •

edited

Loading

Uh oh!

sgbaird left a comment

Uh oh!

sgbaird Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

sgbaird Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

sgbaird Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

sgbaird Nov 19, 2025

Uh oh!

Copilot AI Nov 19, 2025

Uh oh!

Copilot AI commented Nov 19, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Remove template placeholders and tone down documentation #11

Are you sure you want to change the base?

Remove template placeholders and tone down documentation #11

Conversation

Copilot AI commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

PR Feedback Addressed:

Comments on the Issue (you are @copilot in this section)

Uh oh!

sgbaird left a comment

Choose a reason for hiding this comment

Uh oh!

sgbaird Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

sgbaird Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

sgbaird Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

sgbaird Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Nov 19, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Nov 19, 2025 •

edited

Loading