From e1d9b0cfba2dffbde1d9ad878660eb38257c469e Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Wed, 9 May 2018 10:35:16 -0700
Subject: [PATCH] doc: minimal updates re hakyll-std

[ci skip]
---
 doc/README      | 34 +++++++++++++++++-----------------
 site/README     |  9 ++++-----
 site/doc/README | 12 ++++++++----
 3 files changed, 29 insertions(+), 26 deletions(-)

diff --git a/doc/README b/doc/README
index d3251edae..94f78193c 100644
--- a/doc/README
+++ b/doc/README
@@ -56,9 +56,8 @@ $ stack build hledger
 
 The website uses the markdown manuals. This copies them into the
 website, edits them for web display, concatenates them to form the
-one-page manual, and runs hakyll-std (a generic hakyll script,
-included) which adds tables of contents and renders everything as html
-with the site header/footer.
+one-page manual, and runs pandoc to render everything as html,
+adding tables of contents and the site header/footer.
 
 $ ./Shake website
 
@@ -66,20 +65,21 @@ View the rendered website ("open" is mac-specific; use your equivalent):
  
 $ open site/_site/index.html
 
-Or run hakyll in preview mode, regenerating html when source changes: 
-
-$ make site-preview
-$ open http://localhost:8000
-
-Example workflow: edit doc source files, run Shake website in another window, 
-wait for to hakyll rebuild html files, manually reload pages in browser.
-Occasionally hakyll will get confused, to fix it: ctrl-c, make site-clean site-preview . 
-
-You can automate the browser page reloading by running a livereloadx proxy. 
-In another window:
-
-$ make site-reload
-$ open http://localhost:8001  # if the make file didn't do it
+# TODO: this section needs update
+# Or run hakyll in preview mode, regenerating html when source changes: 
+# 
+# $ make site-preview
+# $ open http://localhost:8000
+# 
+# Example workflow: edit doc source files, run Shake website in another window, 
+# wait for to hakyll rebuild html files, manually reload pages in browser.
+# Occasionally hakyll will get confused, to fix it: ctrl-c, make site-clean site-preview . 
+# 
+# You can automate the browser page reloading by running a livereloadx proxy. 
+# In another window:
+# 
+# $ make site-reload
+# $ open http://localhost:8001  # if the make file didn't do it
 
 
 ## Misc. notes
diff --git a/site/README b/site/README
index 3bdfd5749..192768f78 100644
--- a/site/README
+++ b/site/README
@@ -1,5 +1,4 @@
-Static bits of the hledger.org website.
-
-In some cases these are rendered to _site/* by hakyll (via the
-hakyll-std script), in others they are served directly from the git
-working copy. (?)
+Source files for the hledger.org website. 
+To render this, run ./Shake website. 
+This will add the web manuals' markdown to this directory, 
+render all markdown as html, and copy static files, to site/_site/.
diff --git a/site/doc/README b/site/doc/README
index 9e5c65772..b30185389 100644
--- a/site/doc/README
+++ b/site/doc/README
@@ -1,5 +1,9 @@
 Snapshots of past versions of the web content.
-These are in the "doc/" subdirectory so that hakyll-std will see them.
-At each release, a new snapshot should be generated and committed.
-Major releases should also be added to the "available
-versions" links in site.js.
+
+At each major release, a new snapshot should be generated 
+(with ./Shake site/doc/VERSION/.snapshot) and committed.
+
+Major releases should also be added to the "available versions" links in site.js.
+
+TODO: These were in this "doc/" subdirectory so that hakyll-std would see them, perhaps that's no longer necessary.
+