Dev docs: updated sections to group setup steps

mlte-team · Jan 7, 2025 · 9dfd993 · 9dfd993
1 parent 0a37c7e
commit 9dfd993
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/demo/scenarios/demo_script.txt b/demo/scenarios/demo_script.txt
@@ -1,5 +1,5 @@
 Pre-Demo Steps:
- - Execute the Requirements and Demos steps from https://mlte.readthedocs.io/en/latest/development/#quickstart. 
+ - Execute the Requirements and Demos steps from the Setup seciton in https://mlte.readthedocs.io/en/latest/development/#quickstart. 
  - (Optional) Install wget.
  - Execute all notebooks so that the results can be seen in the notebooks themselves. This can be done in VSCode, or in another program that runs Jupyter Notebooks. Be sure to run the notebooks in the virtual environment created at the beginning, so that all dependencies are installed.
  - Ensure that the Docker daemon is running.

diff --git a/docs/docs/development.md b/docs/docs/development.md
@@ -2,7 +2,9 @@
 
 This document describes some of the development practices used within `MLTE`.
 
-## Requirements
+## Setup
+
+### Requirements
 
  - MLTE uses `poetry` to handle the required runtime and development packages. The first step is to install `poetry` on your system. See https://python-poetry.org/docs/#installation. 
  - You also need to set up a virtual Python environment where poetry will work on. While inside the root of the repository, execute this command:
@@ -11,19 +13,19 @@ This document describes some of the development practices used within `MLTE`.
 $ python -m venv .venv
 ```
 
-## Dev Environment Setup
+### Dev Environment Setup
 
-Once poetry and the virtual env are setup, you can set up dev dependencies like this:
+Once poetry and the virtual env are setup, you can set up dev dependencies like this, from the root of the repository:
 
 ```bash
 $ poetry install --with qa,test,build,docs
 ```
 
 Now you are ready to start working on `MLTE`!
 
-## Demos
+### Demos
 
-There are several demos available in the `demo\` folder, as Jupyter notebooks. To run them, you need to install their dependencies first. This can be done with:
+There are several demos available in the `demo\` folder, as Jupyter notebooks. To run them, you need to install their dependencies first. This can be done from the root of the repository with:
 
 ```bash
 $ poetry install --with demo