Merge pull request #54 from Start9Labs/start-cli

refactor environment-setup

Author: MattDHill

.github/workflows/mdbook.yml

@@ -36,6 +36,12 @@ jobs:
           curl -sSL https://github.com/tommilligan/mdbook-admonish/releases/download/${ADMONISH_VERSION}/mdbook-admonish-${ADMONISH_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz
           sudo mv mdbook-admonish /usr/local/bin/mdbook-admonish
 
+      - name: Install mdBook External Links
+        run: |
+          EXTERNAL_LINKS_VERSION=$(curl -s https://api.github.com/repos/jonahgoldwastaken/mdbook-external-links/releases/latest | jq -r '.tag_name')
+          curl -sSL https://github.com/jonahgoldwastaken/mdbook-external-links/releases/download/${EXTERNAL_LINKS_VERSION}/mdbook-external-links-${EXTERNAL_LINKS_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar -xz
+          sudo mv mdbook-external-links /usr/local/bin/mdbook-external-links
+
       - name: Configure mdBook Admonish
         run: mdbook-admonish install .
 

book.toml

@@ -14,6 +14,8 @@ build-dir = "docs"
 command = "mdbook-admonish"
 assets_version = "3.0.2"    # do not edit: managed by `mdbook-admonish install`
 
+[preprocessor.external-links]
+
 [output]
 
 [output.html]

src/packaging-guide/environment-setup.md

@@ -6,46 +6,57 @@ You will need a computer running StartOS to test your package. Follow the [flash
 
 ## Docker
 
-<a href="https://docs.docker.com/get-docker/" target="_blank">Docker</a> is needed to convert docker images to StartOS images.
+[Docker](https://docs.docker.com/get-docker/) is essential for building and managing container images that will be used for final `.s9pk` build. It handles:
 
-## Make
-
-<a href="https://www.gnu.org/software/make/" target="_blank">Make</a> is needed to streamline builds and produce s9pk binaries.
+- Pulling base images for your service containers
+- Building custom container images from Dockerfiles
 
-## NodeJS v22 (latest LTS)
+## Make
 
-<a href="https://nodejs.org/en/" target="_blank">NodeJS</a> is needed to compile the Typescript in your StartOS package.
+[Make](https://www.gnu.org/software/make/) is a build automation tool that streamlines the package creation process and it is used to:
 
-## SquashFS
+- Execute build scripts defined in Makefiles
+- Coordinate the packaging workflow
+- Build and install s9pk binaries to StartOS
+- Automate repetitive development tasks
 
-SquashFS is needed to pack the compiled Javascript into a SquashFS file
+## Node.js v22 (Latest LTS)
 
-##### Linux (Debian-based)
+[Node.js](https://nodejs.org/en/) is required for compiling TypeScript code used in StartOS package configurations.
 
-    sudo apt install squashfs-tools squashfs-tools-ng
+## SquashFS
 
-##### Mac
+**SquashFS** is used to create compressed filesystem images that package your compiled service code.
 
-    brew install squashfs
+### Installation:
 
-## Start CLI
+#### Linux (Debian-based)
 
-<a href="https://github.com/Start9Labs/start-os/" target="_blank">start-cli</a> is needed to interact with StartOS from the command line.
+```sh
+sudo apt install squashfs-tools squashfs-tools-ng
+```
 
-1.  Clone the StartOS repo
+#### macOS
 
-        https://github.com/Start9Labs/start-os.git
+Make sure you have [Homebrew](https://brew.sh/) installed, then:
 
-1.  Initialize the git submodules
+```sh
+brew install squashfs
+```
 
-        git submodule update --init --recursive
+## Start CLI
 
-1.  Build Start CLI
+[start-cli](https://github.com/Start9Labs/start-cli/) is the core development toolkit for building StartOS packages and provides:
 
-        make cli
+- Package validation and verification
+- s9pk file creation and assembly
+- Development workflow management
+- Integration with StartOS systems
 
-1.  Initialize Start CLI
+### Installation:
 
-        start-cli init
+The easiest way to install start-cli is using our automated installer script:
 
-    This will generate a `.startos` directory inside your home directory. This directory will contain a newly-generated `developer.key.pem`, used to sign packages, as well as a default `config.yaml`, which can be edited to customize and streamline your developer experience.
+```
+curl -fsSL https://start9labs.github.io/start-cli | sh
+```