From b83b490688486388b9cdb0cc3337622e473394f5 Mon Sep 17 00:00:00 2001 From: Sebastian Echeverria Date: Tue, 14 Jan 2025 14:51:24 -0500 Subject: [PATCH] Fixing outdated doc links --- demo/scenarios/demo_script.txt | 2 +- docs/docs/development.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/demo/scenarios/demo_script.txt b/demo/scenarios/demo_script.txt index 3ff31e8e..e2248675 100644 --- 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 (and optionally the Python Version Support step if needed) in the Setup section in https://mlte.readthedocs.io/en/latest/development/#quickstart. + - Execute the Requirements and Demos steps (and optionally the Python Version Support step if needed) in the Setup section in https://mlte.readthedocs.io/en/latest/development/#setup. - Execute all notebooks in demo/scenarios 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. - Execute run_environment.sh from demo/scenarios to get the frontend and backend working. diff --git a/docs/docs/development.md b/docs/docs/development.md index e4930733..28763b52 100644 --- a/docs/docs/development.md +++ b/docs/docs/development.md @@ -72,7 +72,7 @@ $ source .venv/bin/activate ### Import Sorting -We sort all Python import code in this project with `isort`. Assuming you have followed the instructions in the [Quickstart](#quickstart), you can run this locally with: +We sort all Python import code in this project with `isort`. You can run this locally with: ```bash $ make isort @@ -88,7 +88,7 @@ Code that does not satisfy the sorter will be rejected from pull requests. ### Source Formatting -We format all Python code in this project with the `black` source formatter. Assuming you have followed the instructions in the [Quickstart](#quickstart), you can run the formatter locally with: +We format all Python code in this project with the `black` source formatter. You can run the formatter locally with: ```bash $ make format @@ -104,7 +104,7 @@ Code that does not satisfy the formatter will be rejected from pull requests. ### Source Linting -We lint all Python code in this project with the `flake8` source linter. Assuming you have followed the instructions in the [Quickstart](#quickstart), you can run the linter locally with: +We lint all Python code in this project with the `flake8` source linter. You can run the linter locally with: ```bash $ make lint @@ -114,7 +114,7 @@ Code that does not satisfy the linter will be rejected from pull requests. ### Static Type Checking -We run static type-checking with `mypy`. Assuming you have followed the instructions in the [Quickstart](#quickstart), you can run the type-checker locally with: +We run static type-checking with `mypy`. You can run the type-checker locally with: ```bash $ make typecheck @@ -132,7 +132,7 @@ $ make docs ### Unit Tests -We unit test the `MLTE` library with the `pytest` package, a test-runner for Python. Assuming you have followed the instructions in the [Quickstart](#quickstart), you can run unit tests locally with: +We unit test the `MLTE` library with the `pytest` package, a test-runner for Python. You can run unit tests locally with: ```bash $ make test @@ -154,7 +154,7 @@ $ make demo-test ### Model Schema Generation -The artifacts used by `MLTE` have schemas that are used to validate them. These schemas need to be updated if their internal structure (code) changes. Assuming you have followed the instructions in the [Quickstart](#quickstart), you can do this locally with: +The artifacts used by `MLTE` have schemas that are used to validate them. These schemas need to be updated if their internal structure (code) changes. You can do this locally with: ```bash $ make schema