Try Gthnk on docs front page

remove diamond methods from docs propagate version to docs index page
iandennismiller · Jul 2, 2023 · aa3e5aa · aa3e5aa
1 parent c69e63e
commit aa3e5aa
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 5 deletions.
diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
@@ -1,8 +1,7 @@
 <h3>Resources</h3>
 <ul>
-    <li><a href="http://gthnk.com">gthnk.com</a></li>
+    <li><a href="http://www.gthnk.com">www.gthnk.com</a></li>
     <li><a href="http://github.com/iandennismiller/gthnk">GitHub Project Page</a></li>
     <li><a href="http://github.com/iandennismiller/gthnk/issues">Issue Tracker</a></li>
     <li><a href="https://pypi.python.org/pypi/gthnk">Python Project on PyPI</a></li>
-    <li><a href="http://diamond-methods.org">Diamond Methods</a></li>
 </ul>
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,13 +1,32 @@
 .. gthnk documentation master file
 
 Overview
---------
+========
 
 - **Gthnk** presents a **journal** consisting of many **entries**.
 - **Entries** are created using plain old text files, which **Gthnk** imports once per day.
 - Any text editor can be used to add information to **Gthnk**.
-- **Entries** are searchable using the embedded **Gthnk** server, which can be accessed with a browser.
-- Plain-text enables backup/restore via hardcopy (e.g. paper) for long-term archival.
+- **Days** and **Entries** are searchable from the command line and web UI.
+
+Try Gthnk
+---------
+
+Use Docker to run Gthnk with all files stored locally in ``~/.gthnk``.
+
+::
+
+    docker run -d --rm \
+        --name gthnk \
+        -p 1620:1620 \
+        -e TZ=America/Toronto \
+        -v ~/.gthnk:/opt/gthnk/var \
+        iandennismiller/gthnk:0.8.1
+
+The default text file where you will record journal entries is ``~/.gthnk/journal.txt``.
+
+Open ``journal.txt`` with a text editor to add new journal entries.
+
+Open http://localhost:1620 to access the user interface.
 
 Introduction
 ------------

diff --git a/src/dev.mk b/src/dev.mk
@@ -30,6 +30,7 @@ docs:
 
 version-propagate:
 	$(REPLACE_VERSION_CMD) Readme.rst && rm Readme.rst.bak
+	$(REPLACE_VERSION_CMD) docs/index.rst && rm docs/index.rst.bak
 	$(REPLACE_VERSION_CMD) docs/intro/quick-start.rst && rm docs/intro/quick-start.rst.bak
 	$(REPLACE_VERSION_CMD) docs/intro/installation.rst && rm docs/intro/installation.rst.bak
 	$(REPLACE_VERSION_CMD) docs/_static/docker-compose.yaml && rm docs/_static/docker-compose.yaml.bak