From 9010908c952c0f250b77d3afefb1142d0c717218 Mon Sep 17 00:00:00 2001 From: Dean Wampler Date: Mon, 4 Nov 2024 09:57:49 -0600 Subject: [PATCH] Updated comment at the top. Signed-off-by: Dean Wampler --- publish-website.sh | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/publish-website.sh b/publish-website.sh index 3085e02..a9f1351 100755 --- a/publish-website.sh +++ b/publish-website.sh @@ -2,10 +2,12 @@ #------------------------------------------------------------------------ # Publish a new version of the site. # This script can be used to publish a new version of this site, which in -# this case means bump the version number and corresponding new timestamp -# that appears on the index page (optionally), the footer of every page in -# the Just the Docs template, and the _config.yaml file, which is where -# the footer gets the value. +# this case means bump the version number and corresponding new timestamp: +# 1. _config.yaml: sets the value shown in the page footers. +# 2. docs/index.markdown: +# a. Authors and latest version table at the top of the page, if present +# b. The history table of versions and timestamps at the bottom, if present. +# c. The footer of every page in the Just the Docs template. # # NOTES: # 1. While recommended, it's not required to use this script...