diff --git a/README.md b/README.md index cc17dcd..9b1d0ce 100644 --- a/README.md +++ b/README.md @@ -1 +1,27 @@ # docs.instructlab.ai + +To test documentation changes locally, you'll need to install `mkdocs` and the relevant dependencies in your Python environment. + +We've included a server launching script for ease of use. + +## Getting Started + +1. Create a virtual environment for your installation. + +```bash +python -m venv venv-ilab-docs +source venv-ilab-docs/bin/activate +``` + +2. Launch the server. + +This will: +* Install mkdocs +* Install the PyPI dependencies +* Launch the mkdocs server locally + +```bash +./launch_server.sh +``` + +3. Visit [https://127.0.0.1:8000/](https://127.0.0.1:8000/) to see your changes in the browser. diff --git a/launch_server.sh b/launch_server.sh new file mode 100755 index 0000000..31c93c4 --- /dev/null +++ b/launch_server.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +# You may want to activate a new virtual environment before running this script, as it will install Python dependencies. + +pip install -U mkdocs + +reqs=$(mkdocs get-deps) + +echo "Installing: " $reqs +pip install -U $reqs + +echo "Starting server..." +mkdocs serve