Closed kris-work closed 2 years ago
I'm revoking this PR. I've decided to wait to submit until I've completed some other outstanding documentation issues.
Reconsidered again. I've re-opened this PR. Since this update includes significant changes, I think it's helpful to review those now.
What was the problem/requirement? (What/Why)
Improve the User Guide by filling documentation gaps and improving doc organization.
Out of scope
What was the solution? (How)
What artifacts are related to this change?
What is the impact of this change? (Focus on the customer experience)
Are you adding any new dependencies to the system?
No
How were these changes tested?
Manually tested by running the
mkdocs serve
command and viewing the generated User Guide in a browser.How to review/test
I recommend reviewers also use the approach above and review the generated docs in the browser so that formatting and images can be reviewed as the user will see them.
Key files
The following are NEW doc pages or pages that had significant changes. Review these with special scrutiny...
How does this commit make you feel? (Optional, but encouraged)
I'm passionate about good user documentation. Happy to be insisting on the highest standards for our docs.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.