Remove template placeholders and tone down documentation #11
Conversation
…guage Co-authored-by: sgbaird <[email protected]>
…irective Co-authored-by: sgbaird <[email protected]>
| > 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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Added specificity about LG-07 and expansion note in 2cef137
docs/bill_of_materials.md
Outdated
| | [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 | |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Added total cost row showing 534.96 USD in 2cef137
docs/installation-and-usage.md
Outdated
|
|
||
| > **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. |
There was a problem hiding this comment.
Append: "The package can also be used standalone, independent of Prefect."
There was a problem hiding this comment.
Added standalone usage note to the existing MyST note directive in 2cef137
docs/installation-and-usage.md
Outdated
| 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")` |
There was a problem hiding this comment.
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)?
There was a problem hiding this comment.
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 <[email protected]>
|
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:
If you need me to access, download, or install something from one of these locations, you can either:
|
There was a problem hiding this comment.
Pull request overview
This PR removes template placeholders and reduces overstated language across documentation and code, achieving a muted, understated tone. The changes address the requirements from issue #10 to avoid "putting on airs" and eliminate obvious or unverifiable instructions.
Key Changes:
- Removed template placeholders and TODO items from docs
- Removed emojis from deployment.py output
- Updated MyST directives in documentation
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/progressive_automations_python/deployment.py | Removed emojis from deployment success messages |
| docs/installation-and-usage.md | Converted to MyST note directive, removed overstated language, added standalone usage note, improved CLI deployment command clarity |
| docs/index.md | Removed template placeholder text and improved description specificity |
| docs/bill_of_materials.md | Simplified tone, added total cost row (though calculation needs verification) |
| README.md | Added specificity about LG-07 system and note about expansion, removed "Perfect for" language |
| CONTRIBUTING.md | Removed all template TODO blocks and updated repository links |
docs/bill_of_materials.md
Outdated
| | [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 | | ||
| | | **Total** | | **534.96 USD** | |
There was a problem hiding this comment.
The total cost calculation appears to be incorrect. Based on the listed prices:
- RT-BT1: 12.34 USD
- AC-25: 5.67 USD × 2 = 11.34 USD
- RT-11: 9.99 USD
- FLTCON-1: 199.00 USD
- LG-07: 749.00 USD
The total should be 981.67 USD, not 534.96 USD.
| | | **Total** | | **534.96 USD** | | |
| | | **Total** | | **981.67 USD** | |
There was a problem hiding this comment.
@copilot No, that's incorrect for the LG-07. Also, just realized it's actually all in CAD.
$380.98 CAD for LG-07. Doesn't seem the FLTCON can be purchased separately though.
Go with this instead (you can just list total and include item list rather than a table)
Shipping Cart
Shipping Cart
Silver-1
LG-07 Modular Lifting Columns with Remote Control Selection
Color: Silver
Number of Columns: 1
Control Box: 1 x FLTCON-1
Remote: 1 x RT-11
Accessories: 1 x RT-BT1
Sku
LG-07-3RM-32-440-HS-24V-N
Quantity
Quantity
Decrease quantity for
1
Increase quantity for
Subtotal
$643.72
Remove item from cart
Loading...
Clear All
Subtotal
$643.72 CAD
There was a problem hiding this comment.
Updated to show $643.72 CAD total with simple list format showing the bundle contents in 6b121e9
Co-authored-by: sgbaird <[email protected]>
|
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:
If you need me to access, download, or install something from one of these locations, you can either:
|
Summary
Updated all documentation to use a muted, understated tone per issue requirements.
Changes:
{note}directive; added standalone usage note; fixed deployment stepOriginal prompt
💡 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.