Cleanup of docs, generator label fix

Signed-off-by: Stephen Curran <[email protected]>

.github/workflows/publish-docs.yml

@@ -43,7 +43,7 @@ jobs:
           sed -e "s#\.\./\.\./#../#" docs/features/DevReadMe.md >tmp.md; mv tmp.md docs/features/DevReadMe.md
           # Populate overrides for the current version, and then remove to not apply if VERSION is main branch
           OVERRIDE=overrides/main.html
-          echo -e "{% extends \"base.html\" %}\n\n{% block outdated %}\n  You are viewing the documentation for ACA-Py Release $ALIAS.\n{% endblock %}" >$OVERRIDE
+          echo -e "{% extends \"base.html\" %}\n\n{% block outdated %}\n  You are viewing the documentation for ACA-Py Release $VERSION.\n{% endblock %}" >$OVERRIDE
           # If building from main, use latest as ALIAS and remove the override
           [ "$VERSION" == "main" ] && ALIAS=latest && rm $OVERRIDE
           echo $VERSION $ALIAS

docs/README.md

@@ -15,6 +15,15 @@ a new release of ACA-Py.
 - For the [ACA-Py ReadTheDocs documentation], see the guidance in the [update RTD] markdown file
 in this repository.
 
+To generate and locally run the docs website, use docker as follows:
+
+- Get a [Material for Mkdocs] docker image with the necessary extensions by running from the ACA_Py root folder:
+  - `docker build -f docs/mkdocs-dockerfile.yml -t squidfunk/mkdocs-material .`
+- Run the resulting docker image from the root folder to generate the website on the current branch:
+  - `docker run --rm -it -p 8000:8000 --name mkdocs-material -v ${PWD}:/docs squidfunk/mkdocs-material`
+  - Open your browser: [http://localhost:8000](http://localhost:8000) and test out the docs.
+
 [aries-acapy-docs]: https://github.com/hyperledger/aries-acapy-docs
 [ACA-Py ReadTheDocs documentation]: https://aries-cloud-agent-python.readthedocs.io
 [update RTD]: ./UpdateRTD.md
+[Material for Mkdocs]: https://squidfunk.github.io/mkdocs-material/