Removed home in sidebar

tymyrddin · Jun 15, 2022 · c3eae65 · c3eae65
1 parent ebbc0f7
commit c3eae65
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/Documentation/docs/code-comments.md b/Documentation/docs/code-comments.md
@@ -19,7 +19,6 @@ Not always true: “if the code is so unclear that it requires a comment, then *
 
 ## Related
 
-* [Hardly any comments yet in FastAPI TDD Docker](https://github.com/tymyrddin/fastapi-tdd-docker)
 * [Plotting code from Pandas in which the docstrings make up more than half of the file](https://github.com/pandas-dev/pandas/blob/main/pandas/plotting/_core.py)
 
 ## Resources

diff --git a/Documentation/docs/troubleshooting-guides.md b/Documentation/docs/troubleshooting-guides.md
@@ -15,11 +15,11 @@ Answers what the common problems are, and how to check for them? Tends to start
 * Don't mistake symptoms for root cause
 * Implement a comprehensive logging infrastructure and use correlation IDs
 * Use system monitors and predictive analytics
-* Publish resolutions and fixes in troubleshooting guides
+* Publish relevant resolutions and fixes in troubleshooting guides
 
 ## Related
 
-* TBD
+* [A Guide to Network Troubleshooting: Basic Steps, Tips and Tools](https://www.comptia.org/content/guides/a-guide-to-network-troubleshooting)
 
 ## Resources
 

diff --git a/Documentation/docs/user-manuals.md b/Documentation/docs/user-manuals.md
@@ -6,7 +6,7 @@ User manuals are on what a software does and how to use it. What follows are too
 
 ## Context
 
-What does someone have to do to get "this" and "that", things the software is supposed to do for a user? The written communication varies from verbose to concise. Examples: [Sphinx Documentation](https://www.sphinx-doc.org/en/master/contents.html) and [The Linux man-pages project](https://www.kernel.org/doc/man-pages/).
+What does someone have to do to get "this" and "that", things the software is supposed to do for a user? The written communication varies from verbose to concise.
 
 Acceptance test: Someone new to the project, not necessarily a developer, can use the code with help of the manual.
 
@@ -22,11 +22,18 @@ Acceptance test: Someone new to the project, not necessarily a developer, can us
   * cautions and warnings
   * [Troubleshooting steps](troubleshooting-guides.md) with examples of the most common error messages
   * contact information in case undocumented questions arise
+  * Do not repeat in the documentation what can be figured out from the tests or by setting a breakpoint, calling the method, and following the execution path.
+
 
 ## Related
 
-Do not repeat in this documentation what can be figured out from the tests or by setting a breakpoint, calling the method, and following the execution path.
+* [Sphinx Documentation](https://www.sphinx-doc.org/en/master/contents.html)
+* [The Linux man-pages project](https://www.kernel.org/doc/man-pages/).
 
 ## Resources
 
-User manuals can be created using a variety of tools. Each tool has its own advantages and disadvantages.
+User manuals can be created using a variety of tools. Each tool has its own advantages and disadvantages.
+
+* [Basic office template](https://templates.office.com/en-us/Professional-manual-TM06207126)
+* [MkDocs](https://www.mkdocs.org/)
+* [Sphinx](https://www.sphinx-doc.org/)