docs: Update documentation section in readmes

alexandrainst · Nov 26, 2024 · 9d8fe38 · 9d8fe38
1 parent a9a7875
commit 9d8fe38
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -38,7 +38,10 @@ running `make docker`.
 ### Automatic Documentation
 
 Run `make docs` to create the documentation in the `docs` folder, which is based on
-your docstrings in your code. You can view this by running `make view-docs`.
+your docstrings in your code. You can publish this documentation to Github Pages by
+running `make publish-docs`. To add more manual documentation pages, simply add more
+Markdown files to the `docs` directory; this will automatically be included in the
+documentation.
 
 ### Automatic Test Coverage Calculation
 

diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md
@@ -114,7 +114,9 @@ running `make docker`.
 
 Run `make docs` to create the documentation in the `docs` folder, which is based on
 your docstrings in your code. You can publish this documentation to Github Pages by
-running `make publish-docs`.
+running `make publish-docs`. To add more manual documentation pages, simply add more
+Markdown files to the `docs` directory; this will automatically be included in the
+documentation.
 
 ### Automatic Test Coverage Calculation