Added quickstart #13
Added quickstart #13
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive quickstart guide to help new users get started with the LARA suite by running a simulated example from an adaptation template. The PR also adds a "Target Audience" section to the main documentation index.
Key changes:
- New quickstart documentation with Docker and Python setup instructions
- Added target audience description to help users understand if LARA is right for them
- Step-by-step guide for running example processes through the orchestrator GUI
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 15 comments.
| File | Description |
|---|---|
| docs/quickstart.md | New comprehensive quickstart guide covering installation, setup, and usage of the LARA suite through a simulated example with both Docker and Python options |
| docs/index.md | Added "Target Audience" section to clarify who should use the LARA framework |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| ## Running with Docker | ||
| Running the example with docker is straightforward, but it does require that you have the |
There was a problem hiding this comment.
The word "docker" should be capitalized as "Docker" for consistency with other references in the document (see lines 16-19).
| Running the example with docker is straightforward, but it does require that you have the | |
| Running the example with Docker is straightforward, but it does require that you have the |
docs/quickstart.md
Outdated
| While the process runs you can observe different features of our framework. | ||
|
|
||
| 1. Live updates of the process in the orchestrator: | ||
| 1. The gantt chart has a moving bar of where in time you currently are |
There was a problem hiding this comment.
The word "gantt" should be capitalized as "Gantt" when referring to a Gantt chart (named after Henry Gantt).
| ## Target Audience | ||
|
|
||
| People who have a robotic arm with several devices they can access via SiLA (or at least python) and look for a | ||
| framework do describe, orchestrate and schedule workflows on these devices. Some programming skills are necessary. |
There was a problem hiding this comment.
The verb form is incorrect. It should be "to describe" instead of "do describe".
| framework do describe, orchestrate and schedule workflows on these devices. Some programming skills are necessary. | |
| framework to describe, orchestrate and schedule workflows on these devices. Some programming skills are necessary. |
cantordust
left a comment
cantordust
left a comment
There was a problem hiding this comment.
Good quickstart tutorial!
| ```bash | ||
| pip install -r requirements.txt -e . | ||
| ``` | ||
| - to also install the example sila servers (necessary for the demo examples to run) add: |
There was a problem hiding this comment.
| - to also install the example sila servers (necessary for the demo examples to run) add: | |
| - to also install the example SiLA servers (necessary for the demo examples), run: |
| ```bash | ||
| python scripts/add_lab_setup_to_db.py | ||
| ``` | ||
| This adds the lab setup as described in platform_config.yml to the database. |
There was a problem hiding this comment.
| This adds the lab setup as described in platform_config.yml to the database. | |
| This adds the lab setup as described in `platform_config.yml` to the database. |
| ## Startup | ||
| Call from different console tabs | ||
|
|
||
| **Option 1:** In gnome terminal you could start all four of the following services in different tabs by running |
There was a problem hiding this comment.
Why is there a specific entry for Gnome Terminal? Does it handle things in a special way that other terminal emulators don't follow?
There was a problem hiding this comment.
In Gnome terminal you have tabs. Maybe not all terminals have that. Stefan tested it on gnome terminal.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
Co-authored-by: Alexander Hadjiivanov <43831101+cantordust@users.noreply.github.com>
Basically plagiarized Stefans adaption template. Will ask him if he is ok with it.