From aa73f11fd0c95d215c200a3a6468529338c88a17 Mon Sep 17 00:00:00 2001
From: Eric Hwang <e@lever.co>
Date: Wed, 29 May 2024 17:07:45 -0700
Subject: [PATCH] [docs] Point main README to new GH Pages doc site, minor doc
 README updates

---
 README.md      |  4 +++-
 docs/README.md | 22 ++++++++++++----------
 2 files changed, 15 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index eac44bf6..1fa0353f 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,9 @@ Derby includes a powerful data synchronization engine called Racer that automati
 
 Derby applications load immediately and can be indexed by search engines, because the same templates render on both server and client. In addition, templates define bindings, which instantly update the view when the model changes and vice versa. Derby makes it simple to write applications that load as fast as a search engine, are as interactive as a document editor, and work offline.
 
-See docs here: **http://derbyjs.com/**
+See docs here: **https://derbyjs.github.io/derby/**
+
+Main site: **https://derbyjs.com/**
 
 Examples here: **https://github.com/derbyjs/derby-examples**
 
diff --git a/docs/README.md b/docs/README.md
index c585e184..b6ca50b6 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,8 +1,10 @@
-These docs are built with Jekyll and served on GitHub Pages.
+These docs are built with Jekyll using the [Just the Docs theme](https://just-the-docs.com/).
+
+They are served on GitHub Pages at [https://derbyjs.github.io/derby/](https://derbyjs.github.io/derby/).
 
 # Locally building and viewing docs
 
-Jekyll has a dev server, which will auto-build the docs upon any changes to the source Markdown files. Only changes to `_config.yml` require a dev server restart.
+Jekyll has a dev server, which will auto-build the docs upon any changes to the docs' source files. Only changes to `_config.yml` require a dev server restart.
 
 ## With local Ruby
 
@@ -18,7 +20,7 @@ Run the dev server:
 bundle exec jekyll serve
 ```
 
-The site is viewable at `http://localhost:4000/`.
+The site is viewable at `http://localhost:4000/derby/`.
 
 ## With Ruby in Docker container
 
@@ -28,17 +30,17 @@ One-time container creation:
 docker run --name derby-docs-ruby -v "$(pwd)/docs:/derby-docs" -p 127.0.0.1:4000:4000 ruby:2.7 bash -c 'cd derby-docs && bundle install && bundle exec jekyll serve -H 0.0.0.0 -P 4000 --trace'
 ```
 
-The site is viewable at `http://localhost:4000/`.
-
-Explanation of flags:
-* `-v` - Set up a Docker bind mount, mapping the host's `$PWD/docs` directory to a container directory `/derby-docs`.
-* `-p` - Map the host's local port 4000 to the container's port 4000, to allow the dev server inside the container to serve requests issued against the host.
-* `-H 0.0.0.0 -P 4000` - Have the dev server listen to connections from outside the container. This won't allow connections from outside the host.
-
 Subsequently, to run the dev server:
 
 ```
 docker start -i derby-docs-ruby
 ```
 
+Either way, the site is viewable at `http://localhost:4000/derby/`.
+
+Explanation of flags:
+* `-v` - Set up a Docker bind mount, mapping the host's `$PWD/docs` directory to a container directory `/derby-docs`.
+* `-p` - Map the host's local port 4000 to the container's port 4000, to allow the dev server inside the container to serve requests issued against the host.
+* `-H 0.0.0.0 -P 4000` - Have the dev server listen to connections from outside the container. This won't allow connections from outside the host.
+
 To recreate the container with a different command or setup, run `docker rm derby-docs-ruby` to delete the container first.