update readme

Author: roye2

README.md

@@ -7,56 +7,53 @@ an open source course management, assignment submission, exam, and grading syste
 To report issues for this repository, please file them under the
 [Submitty/Submitty](https://github.com/Submitty/Submitty) repository.
 
-## Local Development
+## Local Development with Docker (Recommended)
 
-### Prerequisites
-
-To develop the site locally, you will need to get the following dependencies:
-
-* [Ruby](https://www.ruby-lang.org/en/)
-* [Bundler](https://bundler.io/) (`gem install bundler`)
-
-For Bundler, depending on your system, you may need to also install the
-Ruby development headers (e.g. `ruby-dev`). On Ubuntu/Debian,
-for example, this would be accomplished by doing `sudo apt-get install ruby-dev`.
-
-
-### Docker Setup (Recommended)
-
-If you have [Docker](https://www.docker.com/) installed, you can skip
-the Ruby/Bundler prerequisites entirely:
+If you have [Docker](https://www.docker.com/) installed, you do not need to install Ruby or Bundler locally.
 
 1. Clone the repository:
    ```bash
    git clone https://github.com/Submitty/submitty.github.io.git
    cd submitty.github.io
    ```
-2. Start the development server:
+2. Start the development container:
    ```bash
    docker compose up
    ```
-   The first run takes a few minutes to install dependencies. Subsequent
-   runs start in seconds.
+   The first run will take a few minutes to install dependencies.
 
 3. Visit [http://localhost:4000](http://localhost:4000) to view the site.
    Changes to files will automatically trigger a rebuild and refresh your
    browser.
 
-4. To stop the server, press `Ctrl+C` or run:
+4. To stop the development container, press `Ctrl+C` or run:
    ```bash
    docker compose down
    ```
-   To run the link checker with Docker:
-   ```bash
-   docker compose exec docs bundle exec jekyll build
-   docker compose exec docs bundle exec htmlproofer ./_site --assume-extension --empty-alt-ignore --disable_external
-   ```
-If you prefer to set up Ruby natively, see the manual instructions below.
+### Running the link checker
+
+```bash
+docker compose exec site bundle exec jekyll build
+docker compose exec site bundle exec htmlproofer ./_site --assume-extension --empty-alt-ignore --disable_external
+```
+Alternatively, you can develop the site with Ruby and Bundler installed locally. See the instructions below for more information.
+
+## Local Development with Ruby
+
+### Prerequisites
+
+To develop the site locally, you will need to get the following dependencies:
+
+* [Ruby](https://www.ruby-lang.org/en/)
+* [Bundler](https://bundler.io/) (`gem install bundler`)
 
+For Bundler, depending on your system, you may need to also install the
+Ruby development headers (e.g. `ruby-dev`). On Ubuntu/Debian,
+for example, this would be accomplished by doing `sudo apt-get install ruby-dev`.
 
 ### Setup
 
-1. Clone the respository on your local machine, e.g.,
+1. Clone the repository on your local machine, e.g.,
 
    ```
    git clone https://github.com/Submitty/submitty.github.io.git
@@ -163,11 +160,11 @@ above structure. Currently, the site only supports three levels of nesting (sub-
 ## Forked from [Edition](https://github.com/CloudCannon/edition-jekyll-template)
 
 This repository was created via a fork of Edition, which is a product documentation theme for Jekyll created
-by by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll.
+by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll.
 
 
 
 ### Ruby Version Troubleshooting
 
 In February 2024:
-* https://ritviknag.com/tech-tips/ruby-versioning-hell-with-jekyll-&-github-pages/
+* https://ritviknag.com/tech-tips/ruby-versioning-hell-with-jekyll-&-github-pages/

docker-compose.yml

@@ -1,5 +1,5 @@
 services:
-  docs:
+  site:
     build: .
     ports:
       - "4000:4000"